healthcare

package
v0.193.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 20, 2024 License: BSD-3-Clause Imports: 16 Imported by: 40

Documentation

Overview

Package healthcare provides access to the Cloud Healthcare API.

For product documentation, see: https://cloud.google.com/healthcare

Library status

These client libraries are officially supported by Google. However, this library is considered complete and is in maintenance mode. This means that we will address critical bugs and security issues but will not add any new features.

When possible, we recommend using our newer [Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go) that are still actively being worked and iterated on.

Creating a client

Usage example:

import "google.golang.org/api/healthcare/v1"
...
ctx := context.Background()
healthcareService, err := healthcare.NewService(ctx)

In this example, Google Application Default Credentials are used for authentication. For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

By default, all available scopes (see "Constants") are used to authenticate. To restrict scopes, use google.golang.org/api/option.WithScopes:

healthcareService, err := healthcare.NewService(ctx, option.WithScopes(healthcare.CloudPlatformScope))

To use an API key for authentication (note: some APIs do not support API keys), use google.golang.org/api/option.WithAPIKey:

healthcareService, err := healthcare.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow, use google.golang.org/api/option.WithTokenSource:

config := &oauth2.Config{...}
// ...
token, err := config.Exchange(ctx, ...)
healthcareService, err := healthcare.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

See google.golang.org/api/option.ClientOption for details on options.

Index

Constants

View Source
const (
	// Read, write and manage healthcare data
	CloudHealthcareScope = "https://www.googleapis.com/auth/cloud-healthcare"

	// See, edit, configure, and delete your Google Cloud data and see the email
	// address for your Google Account.
	CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
)

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type ActivateConsentRequest added in v0.41.0

type ActivateConsentRequest struct {
	// ConsentArtifact: Required. The resource name of the Consent artifact that
	// contains documentation of the user's consent, of the form
	// `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentS
	// tores/{consent_store_id}/consentArtifacts/{consent_artifact_id}`. If the
	// draft Consent had a Consent artifact, this Consent artifact overwrites it.
	ConsentArtifact string `json:"consentArtifact,omitempty"`
	// ExpireTime: Timestamp in UTC of when this Consent is considered expired.
	ExpireTime string `json:"expireTime,omitempty"`
	// Ttl: The time to live for this Consent from when it is marked as active.
	Ttl string `json:"ttl,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ConsentArtifact") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ConsentArtifact") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ActivateConsentRequest: Activates the latest revision of the specified Consent by committing a new revision with `state` updated to `ACTIVE`. If the latest revision of the given Consent is in the `ACTIVE` state, no new revision is committed. A FAILED_PRECONDITION error occurs if the latest revision of the given consent is in the `REJECTED` or `REVOKED` state.

func (ActivateConsentRequest) MarshalJSON added in v0.41.0

func (s ActivateConsentRequest) MarshalJSON() ([]byte, error)

type AnalyzeEntitiesRequest added in v0.57.0

type AnalyzeEntitiesRequest struct {
	// AlternativeOutputFormat: Optional. Alternative output format to be generated
	// based on the results of analysis.
	//
	// Possible values:
	//   "ALTERNATIVE_OUTPUT_FORMAT_UNSPECIFIED" - No alternative output format is
	// specified.
	//   "FHIR_BUNDLE" - FHIR bundle output.
	AlternativeOutputFormat string `json:"alternativeOutputFormat,omitempty"`
	// DocumentContent: document_content is a document to be annotated.
	DocumentContent string `json:"documentContent,omitempty"`
	// LicensedVocabularies: A list of licensed vocabularies to use in the request,
	// in addition to the default unlicensed vocabularies.
	//
	// Possible values:
	//   "LICENSED_VOCABULARY_UNSPECIFIED" - No licensed vocabulary specified.
	//   "ICD10CM" - ICD-10-CM vocabulary
	//   "SNOMEDCT_US" - SNOMED CT (US version) vocabulary
	LicensedVocabularies []string `json:"licensedVocabularies,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AlternativeOutputFormat") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AlternativeOutputFormat") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

AnalyzeEntitiesRequest: The request to analyze healthcare entities in a document.

func (AnalyzeEntitiesRequest) MarshalJSON added in v0.57.0

func (s AnalyzeEntitiesRequest) MarshalJSON() ([]byte, error)

type AnalyzeEntitiesResponse added in v0.57.0

type AnalyzeEntitiesResponse struct {
	// Entities: The union of all the candidate entities that the entity_mentions
	// in this response could link to. These are UMLS concepts or normalized
	// mention content.
	Entities []*Entity `json:"entities,omitempty"`
	// EntityMentions: The `entity_mentions` field contains all the annotated
	// medical entities that were mentioned in the provided document.
	EntityMentions []*EntityMention `json:"entityMentions,omitempty"`
	// FhirBundle: The FHIR bundle (`R4` (http://hl7.org/fhir/R4/bundle.html)) that
	// includes all the entities, the entity mentions, and the relationships in
	// JSON format.
	FhirBundle string `json:"fhirBundle,omitempty"`
	// Relationships: relationships contains all the binary relationships that were
	// identified between entity mentions within the provided document.
	Relationships []*EntityMentionRelationship `json:"relationships,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Entities") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Entities") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

AnalyzeEntitiesResponse: Includes recognized entity mentions and relationships between them.

func (AnalyzeEntitiesResponse) MarshalJSON added in v0.57.0

func (s AnalyzeEntitiesResponse) MarshalJSON() ([]byte, error)

type ArchiveUserDataMappingRequest added in v0.41.0

type ArchiveUserDataMappingRequest struct {
}

ArchiveUserDataMappingRequest: Archives the specified User data mapping.

type ArchiveUserDataMappingResponse added in v0.41.0

type ArchiveUserDataMappingResponse struct {
	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
}

ArchiveUserDataMappingResponse: Archives the specified User data mapping.

type Attribute added in v0.41.0

type Attribute struct {
	// AttributeDefinitionId: Indicates the name of an attribute defined in the
	// consent store.
	AttributeDefinitionId string `json:"attributeDefinitionId,omitempty"`
	// Values: Required. The value of the attribute. Must be an acceptable value as
	// defined in the consent store. For example, if the consent store defines
	// "data type" with acceptable values "questionnaire" and "step-count", when
	// the attribute name is data type, this field must contain one of those
	// values.
	Values []string `json:"values,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AttributeDefinitionId") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AttributeDefinitionId") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Attribute: 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.

func (Attribute) MarshalJSON added in v0.41.0

func (s Attribute) MarshalJSON() ([]byte, error)

type AttributeDefinition added in v0.41.0

type AttributeDefinition struct {
	// AllowedValues: Required. Possible values for the attribute. The number of
	// allowed values must not exceed 500. An empty list is invalid. The list can
	// only be expanded after creation.
	AllowedValues []string `json:"allowedValues,omitempty"`
	// Category: Required. The category of the attribute. The value of this field
	// cannot be changed after creation.
	//
	// Possible values:
	//   "CATEGORY_UNSPECIFIED" - No category specified. This option is invalid.
	//   "RESOURCE" - Specify this category when this attribute describes the
	// properties of resources. For example, data anonymity or data type.
	//   "REQUEST" - Specify this category when this attribute describes the
	// properties of requests. For example, requester's role or requester's
	// organization.
	Category string `json:"category,omitempty"`
	// ConsentDefaultValues: Optional. Default values of the attribute in Consents.
	// If no default values are specified, it defaults to an empty value.
	ConsentDefaultValues []string `json:"consentDefaultValues,omitempty"`
	// DataMappingDefaultValue: Optional. Default value of the attribute in User
	// data mappings. If no default value is specified, it defaults to an empty
	// value. This field is only applicable to attributes of the category
	// `RESOURCE`.
	DataMappingDefaultValue string `json:"dataMappingDefaultValue,omitempty"`
	// Description: Optional. A description of the attribute.
	Description string `json:"description,omitempty"`
	// Name: Identifier. Resource name of the Attribute definition, of the form
	// `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentS
	// tores/{consent_store_id}/attributeDefinitions/{attribute_definition_id}`.
	// Cannot be changed after creation.
	Name string `json:"name,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "AllowedValues") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AllowedValues") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

AttributeDefinition: A client-defined consent attribute.

func (AttributeDefinition) MarshalJSON added in v0.41.0

func (s AttributeDefinition) MarshalJSON() ([]byte, error)

type AuditConfig

type AuditConfig struct {
	// AuditLogConfigs: The configuration for logging of each type of permission.
	AuditLogConfigs []*AuditLogConfig `json:"auditLogConfigs,omitempty"`
	// Service: Specifies a service that will be enabled for audit logging. For
	// example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices`
	// is a special value that covers all services.
	Service string `json:"service,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AuditLogConfigs") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AuditLogConfigs") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

AuditConfig: 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.

func (AuditConfig) MarshalJSON

func (s AuditConfig) MarshalJSON() ([]byte, error)

type AuditLogConfig

type AuditLogConfig struct {
	// ExemptedMembers: Specifies the identities that do not cause logging for this
	// type of permission. Follows the same format of Binding.members.
	ExemptedMembers []string `json:"exemptedMembers,omitempty"`
	// LogType: The log type that this config enables.
	//
	// Possible values:
	//   "LOG_TYPE_UNSPECIFIED" - Default case. Should never be this.
	//   "ADMIN_READ" - Admin reads. Example: CloudIAM getIamPolicy
	//   "DATA_WRITE" - Data writes. Example: CloudSQL Users create
	//   "DATA_READ" - Data reads. Example: CloudSQL Users list
	LogType string `json:"logType,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ExemptedMembers") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ExemptedMembers") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

AuditLogConfig: 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.

func (AuditLogConfig) MarshalJSON

func (s AuditLogConfig) MarshalJSON() ([]byte, error)

type Binding

type Binding struct {
	// Condition: The condition that is associated with this binding. If the
	// condition evaluates to `true`, then this binding applies to the current
	// request. If the condition evaluates to `false`, then this binding does not
	// apply to the current request. However, a different role binding might grant
	// the same role to one or more of the principals in this binding. To learn
	// which resources support conditions in their IAM policies, see the IAM
	// documentation
	// (https://cloud.google.com/iam/help/conditions/resource-policies).
	Condition *Expr `json:"condition,omitempty"`
	// Members: Specifies the principals requesting access for a Google Cloud
	// resource. `members` can have the following values: * `allUsers`: A special
	// identifier that represents anyone who is on the internet; with or without a
	// Google account. * `allAuthenticatedUsers`: A special identifier that
	// represents anyone who is authenticated with a Google account or a service
	// account. Does not include identities that come from external identity
	// providers (IdPs) through identity federation. * `user:{emailid}`: An email
	// address that represents a specific Google account. For example,
	// `alice@example.com` . * `serviceAccount:{emailid}`: An email address that
	// represents a Google service account. For example,
	// `my-other-app@appspot.gserviceaccount.com`. *
	// `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
	// identifier for a Kubernetes service account
	// (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
	// For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. *
	// `group:{emailid}`: An email address that represents a Google group. For
	// example, `admins@example.com`. * `domain:{domain}`: The G Suite domain
	// (primary) that represents all the users of that domain. For example,
	// `google.com` or `example.com`. *
	// `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/sub
	// ject/{subject_attribute_value}`: A single identity in a workforce identity
	// pool. *
	// `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/
	// group/{group_id}`: All workforce identities in a group. *
	// `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/
	// attribute.{attribute_name}/{attribute_value}`: All workforce identities with
	// a specific attribute value. *
	// `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/
	// *`: All identities in a workforce identity pool. *
	// `principal://iam.googleapis.com/projects/{project_number}/locations/global/wo
	// rkloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single
	// identity in a workload identity pool. *
	// `principalSet://iam.googleapis.com/projects/{project_number}/locations/global
	// /workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool
	// group. *
	// `principalSet://iam.googleapis.com/projects/{project_number}/locations/global
	// /workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}
	// `: All identities in a workload identity pool with a certain attribute. *
	// `principalSet://iam.googleapis.com/projects/{project_number}/locations/global
	// /workloadIdentityPools/{pool_id}/*`: All identities in a workload identity
	// pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus
	// unique identifier) representing a user that has been recently deleted. For
	// example, `alice@example.com?uid=123456789012345678901`. If the user is
	// recovered, this value reverts to `user:{emailid}` and the recovered user
	// retains the role in the binding. *
	// `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
	// unique identifier) representing a service account that has been recently
	// deleted. For example,
	// `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the
	// service account is undeleted, this value reverts to
	// `serviceAccount:{emailid}` and the undeleted service account retains the
	// role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email
	// address (plus unique identifier) representing a Google group that has been
	// recently deleted. For example,
	// `admins@example.com?uid=123456789012345678901`. If the group is recovered,
	// this value reverts to `group:{emailid}` and the recovered group retains the
	// role in the binding. *
	// `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool
	// _id}/subject/{subject_attribute_value}`: Deleted single identity in a
	// workforce identity pool. For example,
	// `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-po
	// ol-id/subject/my-subject-attribute-value`.
	Members []string `json:"members,omitempty"`
	// Role: Role that is assigned to the list of `members`, or principals. For
	// example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview
	// of the IAM roles and permissions, see the IAM documentation
	// (https://cloud.google.com/iam/docs/roles-overview). For a list of the
	// available pre-defined roles, see here
	// (https://cloud.google.com/iam/docs/understanding-roles).
	Role string `json:"role,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Condition") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Condition") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Binding: Associates `members`, or principals, with a `role`.

func (Binding) MarshalJSON

func (s Binding) MarshalJSON() ([]byte, error)

type CancelOperationRequest

type CancelOperationRequest struct {
}

CancelOperationRequest: The request message for Operations.CancelOperation.

type CharacterMaskConfig

type CharacterMaskConfig struct {
	// MaskingCharacter: Character to mask the sensitive values. If not supplied,
	// defaults to "*".
	MaskingCharacter string `json:"maskingCharacter,omitempty"`
	// ForceSendFields is a list of field names (e.g. "MaskingCharacter") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "MaskingCharacter") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (CharacterMaskConfig) MarshalJSON

func (s CharacterMaskConfig) MarshalJSON() ([]byte, error)

type CheckDataAccessRequest added in v0.41.0

type CheckDataAccessRequest struct {
	// ConsentList: Optional. Specific Consents to evaluate the access request
	// against. These Consents must have the same `user_id` as the evaluated User
	// data mapping, must exist in the current `consent_store`, and have a `state`
	// of either `ACTIVE` or `DRAFT`. A maximum of 100 Consents can be provided
	// here. If no selection is specified, the access request is evaluated against
	// all `ACTIVE` unexpired Consents with the same `user_id` as the evaluated
	// User data mapping.
	ConsentList *ConsentList `json:"consentList,omitempty"`
	// DataId: Required. The unique identifier of the resource to check access for.
	// This identifier must correspond to a User data mapping in the given consent
	// store.
	DataId string `json:"dataId,omitempty"`
	// RequestAttributes: The values of request attributes associated with this
	// access request.
	RequestAttributes map[string]string `json:"requestAttributes,omitempty"`
	// ResponseView: Optional. The view for CheckDataAccessResponse. If
	// unspecified, defaults to `BASIC` and returns `consented` as `TRUE` or
	// `FALSE`.
	//
	// Possible values:
	//   "RESPONSE_VIEW_UNSPECIFIED" - No response view specified. The API will
	// default to the BASIC view.
	//   "BASIC" - Only the `consented` field is populated in
	// CheckDataAccessResponse.
	//   "FULL" - All fields within CheckDataAccessResponse are populated. When set
	// to `FULL`, all `ACTIVE` Consents are evaluated even if a matching policy is
	// found during evaluation.
	ResponseView string `json:"responseView,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ConsentList") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ConsentList") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

CheckDataAccessRequest: Checks if a particular data_id of a User data mapping in the given consent store is consented for a given use.

func (CheckDataAccessRequest) MarshalJSON added in v0.41.0

func (s CheckDataAccessRequest) MarshalJSON() ([]byte, error)

type CheckDataAccessResponse added in v0.41.0

type CheckDataAccessResponse struct {
	// ConsentDetails: The resource names of all evaluated Consents mapped to their
	// evaluation.
	ConsentDetails map[string]ConsentEvaluation `json:"consentDetails,omitempty"`
	// Consented: Whether the requested resource is consented for the given use.
	Consented bool `json:"consented,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "ConsentDetails") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ConsentDetails") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

CheckDataAccessResponse: Checks if a particular data_id of a User data mapping in the given consent store is consented for a given use.

func (CheckDataAccessResponse) MarshalJSON added in v0.41.0

func (s CheckDataAccessResponse) MarshalJSON() ([]byte, error)
type Consent struct {
	// ConsentArtifact: Required. The resource name of the Consent artifact that
	// contains proof of the end user's consent, of the form
	// `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentS
	// tores/{consent_store_id}/consentArtifacts/{consent_artifact_id}`.
	ConsentArtifact string `json:"consentArtifact,omitempty"`
	// ExpireTime: Timestamp in UTC of when this Consent is considered expired.
	ExpireTime string `json:"expireTime,omitempty"`
	// Metadata: Optional. User-supplied key-value pairs used to organize Consent
	// resources. Metadata keys must: - be between 1 and 63 characters long - have
	// a UTF-8 encoding of maximum 128 bytes - begin with a letter - consist of up
	// to 63 characters including lowercase letters, numeric characters,
	// underscores, and dashes Metadata values must be: - be between 1 and 63
	// characters long - have a UTF-8 encoding of maximum 128 bytes - consist of up
	// to 63 characters including lowercase letters, numeric characters,
	// underscores, and dashes No more than 64 metadata entries can be associated
	// with a given consent.
	Metadata map[string]string `json:"metadata,omitempty"`
	// Name: Identifier. Resource name of the Consent, of the form
	// `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentS
	// tores/{consent_store_id}/consents/{consent_id}`. Cannot be changed after
	// creation.
	Name string `json:"name,omitempty"`
	// Policies: Optional. Represents a user's consent in terms of the resources
	// that can be accessed and under what conditions.
	Policies []*GoogleCloudHealthcareV1ConsentPolicy `json:"policies,omitempty"`
	// RevisionCreateTime: Output only. The timestamp that the revision was
	// created.
	RevisionCreateTime string `json:"revisionCreateTime,omitempty"`
	// RevisionId: Output only. The revision ID of the Consent. The format is an
	// 8-character hexadecimal string. Refer to a specific revision of a Consent by
	// appending `@{revision_id}` to the Consent's resource name.
	RevisionId string `json:"revisionId,omitempty"`
	// State: Required. Indicates the current state of this Consent.
	//
	// Possible values:
	//   "STATE_UNSPECIFIED" - No state specified. Treated as ACTIVE only at the
	// time of resource creation.
	//   "ACTIVE" - The Consent is active and is considered when evaluating a
	// user's consent on resources.
	//   "ARCHIVED" - The archived state is currently not being used.
	//   "REVOKED" - A revoked Consent is not considered when evaluating a user's
	// consent on resources.
	//   "DRAFT" - A draft Consent is not considered when evaluating a user's
	// consent on resources unless explicitly specified.
	//   "REJECTED" - When a draft Consent is rejected by a user, it is set to a
	// rejected state. A rejected Consent is not considered when evaluating a
	// user's consent on resources.
	State string `json:"state,omitempty"`
	// Ttl: Input only. The time to live for this Consent from when it is created.
	Ttl string `json:"ttl,omitempty"`
	// UserId: Required. User's UUID provided by the client.
	UserId string `json:"userId,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "ConsentArtifact") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ConsentArtifact") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Consent: Represents a user's consent.

func (Consent) MarshalJSON added in v0.41.0

func (s Consent) MarshalJSON() ([]byte, error)

type ConsentArtifact added in v0.41.0

type ConsentArtifact struct {
	// ConsentContentScreenshots: Optional. Screenshots, PDFs, or other binary
	// information documenting the user's consent.
	ConsentContentScreenshots []*Image `json:"consentContentScreenshots,omitempty"`
	// ConsentContentVersion: Optional. An string indicating the version of the
	// consent information shown to the user.
	ConsentContentVersion string `json:"consentContentVersion,omitempty"`
	// GuardianSignature: Optional. A signature from a guardian.
	GuardianSignature *Signature `json:"guardianSignature,omitempty"`
	// Metadata: Optional. Metadata associated with the Consent artifact. For
	// example, the consent locale or user agent version.
	Metadata map[string]string `json:"metadata,omitempty"`
	// Name: Identifier. Resource name of the Consent artifact, of the form
	// `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentS
	// tores/{consent_store_id}/consentArtifacts/{consent_artifact_id}`. Cannot be
	// changed after creation.
	Name string `json:"name,omitempty"`
	// UserId: Required. User's UUID provided by the client.
	UserId string `json:"userId,omitempty"`
	// UserSignature: Optional. User's signature.
	UserSignature *Signature `json:"userSignature,omitempty"`
	// WitnessSignature: Optional. A signature from a witness.
	WitnessSignature *Signature `json:"witnessSignature,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "ConsentContentScreenshots")
	// to unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ConsentContentScreenshots") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ConsentArtifact: Documentation of a user's consent.

func (ConsentArtifact) MarshalJSON added in v0.41.0

func (s ConsentArtifact) MarshalJSON() ([]byte, error)

type ConsentEvaluation added in v0.41.0

type ConsentEvaluation struct {
	// EvaluationResult: The evaluation result.
	//
	// Possible values:
	//   "EVALUATION_RESULT_UNSPECIFIED" - No evaluation result specified. This
	// option is invalid.
	//   "NOT_APPLICABLE" - The Consent is not applicable to the requested access
	// determination. For example, the Consent does not apply to the user for which
	// the access determination is requested, or it has a `state` of `REVOKED`, or
	// it has expired.
	//   "NO_MATCHING_POLICY" - The Consent does not have a policy that matches the
	// `resource_attributes` of the evaluated resource.
	//   "NO_SATISFIED_POLICY" - The Consent has at least one policy that matches
	// the `resource_attributes` of the evaluated resource, but no
	// `authorization_rule` was satisfied.
	//   "HAS_SATISFIED_POLICY" - The Consent has at least one policy that matches
	// the `resource_attributes` of the evaluated resource, and at least one
	// `authorization_rule` was satisfied.
	EvaluationResult string `json:"evaluationResult,omitempty"`
	// ForceSendFields is a list of field names (e.g. "EvaluationResult") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "EvaluationResult") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ConsentEvaluation: The detailed evaluation of a particular Consent.

func (ConsentEvaluation) MarshalJSON added in v0.41.0

func (s ConsentEvaluation) MarshalJSON() ([]byte, error)

type ConsentList added in v0.41.0

type ConsentList struct {
	// Consents: The resource names of the Consents to evaluate against, of the
	// form
	// `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentS
	// tores/{consent_store_id}/consents/{consent_id}`.
	Consents []string `json:"consents,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Consents") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Consents") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ConsentList: List of resource names of Consent resources.

func (ConsentList) MarshalJSON added in v0.41.0

func (s ConsentList) MarshalJSON() ([]byte, error)

type ConsentStore added in v0.41.0

type ConsentStore struct {
	// DefaultConsentTtl: Optional. Default time to live for Consents created in
	// this store. Must be at least 24 hours. Updating this field will not affect
	// the expiration time of existing consents.
	DefaultConsentTtl string `json:"defaultConsentTtl,omitempty"`
	// EnableConsentCreateOnUpdate: Optional. If `true`, UpdateConsent creates the
	// Consent if it does not already exist. If unspecified, defaults to `false`.
	EnableConsentCreateOnUpdate bool `json:"enableConsentCreateOnUpdate,omitempty"`
	// Labels: Optional. User-supplied key-value pairs used to organize consent
	// 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 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. For more information:
	// https://cloud.google.com/healthcare/docs/how-tos/labeling-resources
	Labels map[string]string `json:"labels,omitempty"`
	// Name: Identifier. Resource name of the consent store, of the form
	// `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentS
	// tores/{consent_store_id}`. Cannot be changed after creation.
	Name string `json:"name,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "DefaultConsentTtl") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "DefaultConsentTtl") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ConsentStore: Represents a consent store.

func (ConsentStore) MarshalJSON added in v0.41.0

func (s ConsentStore) MarshalJSON() ([]byte, error)

type CreateMessageRequest

type CreateMessageRequest struct {
	// Message: Required. HL7v2 message.
	Message *Message `json:"message,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Message") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Message") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

CreateMessageRequest: Creates a new message.

func (CreateMessageRequest) MarshalJSON

func (s CreateMessageRequest) MarshalJSON() ([]byte, error)

type CryptoHashConfig

type CryptoHashConfig struct {
	// CryptoKey: 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.
	CryptoKey string `json:"cryptoKey,omitempty"`
	// KmsWrapped: KMS wrapped key. Must not be set if `crypto_key` is set.
	KmsWrapped *KmsWrappedCryptoKey `json:"kmsWrapped,omitempty"`
	// ForceSendFields is a list of field names (e.g. "CryptoKey") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "CryptoKey") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

CryptoHashConfig: Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. Outputs a base64-encoded representation of the hashed output (for example, `L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=`).

func (CryptoHashConfig) MarshalJSON

func (s CryptoHashConfig) MarshalJSON() ([]byte, error)

type Dataset

type Dataset struct {
	// EncryptionSpec: Optional. Customer-managed encryption key spec for a
	// Dataset. If set, this Dataset and all of its sub-resources will be secured
	// by this key. If empty, the Dataset is secured by the default Google
	// encryption key.
	EncryptionSpec *EncryptionSpec `json:"encryptionSpec,omitempty"`
	// Name: Identifier. Resource name of the dataset, of the form
	// `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`.
	Name string `json:"name,omitempty"`
	// TimeZone: Optional. The default timezone used by this dataset. Must be a
	// either a valid IANA time zone name such as "America/New_York" or empty,
	// which defaults to UTC. This is used for parsing times in resources, such as
	// HL7 messages, where no explicit timezone is specified.
	TimeZone string `json:"timeZone,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "EncryptionSpec") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "EncryptionSpec") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Dataset: A message representing a health dataset. A health dataset represents a collection of healthcare data pertaining to one or more patients. This may include multiple modalities of healthcare data, such as electronic medical records or medical imaging data.

func (Dataset) MarshalJSON

func (s Dataset) MarshalJSON() ([]byte, error)

type DateShiftConfig

type DateShiftConfig struct {
	// CryptoKey: 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.
	CryptoKey string `json:"cryptoKey,omitempty"`
	// KmsWrapped: 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.
	KmsWrapped *KmsWrappedCryptoKey `json:"kmsWrapped,omitempty"`
	// ForceSendFields is a list of field names (e.g. "CryptoKey") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "CryptoKey") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (DateShiftConfig) MarshalJSON

func (s DateShiftConfig) MarshalJSON() ([]byte, error)

type DeidentifiedStoreDestination added in v0.98.0

type DeidentifiedStoreDestination struct {
	// Config: The configuration to use when de-identifying resources that are
	// added to this store.
	Config *DeidentifyConfig `json:"config,omitempty"`
	// Store: The full resource name of a Cloud Healthcare FHIR store, for example,
	// `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStor
	// es/{fhir_store_id}`.
	Store string `json:"store,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Config") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Config") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

DeidentifiedStoreDestination: Contains configuration for streaming de-identified FHIR export.

func (DeidentifiedStoreDestination) MarshalJSON added in v0.98.0

func (s DeidentifiedStoreDestination) MarshalJSON() ([]byte, error)

type DeidentifyConfig

type DeidentifyConfig struct {
	// Dicom: Configures de-id of application/DICOM content.
	Dicom *DicomConfig `json:"dicom,omitempty"`
	// Fhir: Configures de-id of application/FHIR content.
	Fhir *FhirConfig `json:"fhir,omitempty"`
	// Image: Configures de-identification of image pixels wherever they are found
	// in the source_dataset.
	Image *ImageConfig `json:"image,omitempty"`
	// Text: Configures de-identification of text wherever it is found in the
	// source_dataset.
	Text *TextConfig `json:"text,omitempty"`
	// UseRegionalDataProcessing: Ensures in-flight data remains in the region of
	// origin during de-identification. The default value is false. Using this
	// option results in a significant reduction of throughput, and is not
	// compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. `LOCATION` must
	// be excluded within TextConfig, and must also be excluded within ImageConfig
	// if image redaction is required.
	UseRegionalDataProcessing bool `json:"useRegionalDataProcessing,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Dicom") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Dicom") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

DeidentifyConfig: 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.

func (DeidentifyConfig) MarshalJSON

func (s DeidentifyConfig) MarshalJSON() ([]byte, error)

type DeidentifyDatasetRequest

type DeidentifyDatasetRequest struct {
	// Config: Deidentify configuration. Only one of `config` and `gcs_config_uri`
	// can be specified.
	Config *DeidentifyConfig `json:"config,omitempty"`
	// DestinationDataset: Required. The name of the dataset resource to create and
	// write the redacted data to. * The destination dataset must not exist. * The
	// destination dataset must be in the same location as the source dataset.
	// De-identifying data across multiple locations is not supported.
	DestinationDataset string `json:"destinationDataset,omitempty"`
	// GcsConfigUri: Cloud Storage location to read the JSON
	// cloud.healthcare.deidentify.DeidentifyConfig from, overriding the default
	// config. Must be of the form `gs://{bucket_id}/path/to/object`. The Cloud
	// Storage location must grant the Cloud IAM role `roles/storage.objectViewer`
	// to the project's Cloud Healthcare Service Agent service account. Only one of
	// `config` and `gcs_config_uri` can be specified.
	GcsConfigUri string `json:"gcsConfigUri,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Config") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Config") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

DeidentifyDatasetRequest: Redacts identifying information from the specified dataset.

func (DeidentifyDatasetRequest) MarshalJSON

func (s DeidentifyDatasetRequest) MarshalJSON() ([]byte, error)

type DeidentifyDicomStoreRequest

type DeidentifyDicomStoreRequest struct {
	// Config: Deidentify configuration. Only one of `config` and `gcs_config_uri`
	// can be specified.
	Config *DeidentifyConfig `json:"config,omitempty"`
	// DestinationStore: Required. The name of the DICOM store to create and write
	// the redacted data to. For example,
	// `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomSto
	// res/{dicom_store_id}`. * The destination dataset must exist. * The source
	// dataset and destination dataset must both reside in the same location.
	// De-identifying data across multiple locations is not supported. * The
	// destination DICOM store must not exist. * The caller must have the necessary
	// permissions to create the destination DICOM store.
	DestinationStore string `json:"destinationStore,omitempty"`
	// FilterConfig: Filter configuration.
	FilterConfig *DicomFilterConfig `json:"filterConfig,omitempty"`
	// GcsConfigUri: Cloud Storage location to read the JSON
	// cloud.healthcare.deidentify.DeidentifyConfig from, overriding the default
	// config. Must be of the form `gs://{bucket_id}/path/to/object`. The Cloud
	// Storage location must grant the Cloud IAM role `roles/storage.objectViewer`
	// to the project's Cloud Healthcare Service Agent service account. Only one of
	// `config` and `gcs_config_uri` can be specified.
	GcsConfigUri string `json:"gcsConfigUri,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Config") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Config") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

DeidentifyDicomStoreRequest: Creates a new DICOM store with sensitive information de-identified.

func (DeidentifyDicomStoreRequest) MarshalJSON

func (s DeidentifyDicomStoreRequest) MarshalJSON() ([]byte, error)

type DeidentifyFhirStoreRequest

type DeidentifyFhirStoreRequest struct {
	// Config: Deidentify configuration. Only one of `config` and `gcs_config_uri`
	// can be specified.
	Config *DeidentifyConfig `json:"config,omitempty"`
	// DestinationStore: Required. The name of the FHIR store to create and write
	// the redacted data to. For example,
	// `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStor
	// es/{fhir_store_id}`. * The destination dataset must exist. * The source
	// dataset and destination dataset must both reside in the same location.
	// De-identifying data across multiple locations is not supported. * The
	// destination FHIR store must exist. * The caller must have the
	// healthcare.fhirResources.update permission to write to the destination FHIR
	// store.
	DestinationStore string `json:"destinationStore,omitempty"`
	// GcsConfigUri: Cloud Storage location to read the JSON
	// cloud.healthcare.deidentify.DeidentifyConfig from, overriding the default
	// config. Must be of the form `gs://{bucket_id}/path/to/object`. The Cloud
	// Storage location must grant the Cloud IAM role `roles/storage.objectViewer`
	// to the project's Cloud Healthcare Service Agent service account. Only one of
	// `config` and `gcs_config_uri` can be specified.
	GcsConfigUri string `json:"gcsConfigUri,omitempty"`
	// ResourceFilter: A filter specifying the resources to include in the output.
	// If not specified, all resources are included in the output.
	ResourceFilter *FhirFilter `json:"resourceFilter,omitempty"`
	// SkipModifiedResources: If true, skips resources that are created or modified
	// after the de-identify operation is created.
	SkipModifiedResources bool `json:"skipModifiedResources,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Config") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Config") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

DeidentifyFhirStoreRequest: Creates a new FHIR store with sensitive information de-identified.

func (DeidentifyFhirStoreRequest) MarshalJSON

func (s DeidentifyFhirStoreRequest) MarshalJSON() ([]byte, error)

type DeidentifySummary

type DeidentifySummary struct {
}

DeidentifySummary: Contains a summary of the Deidentify operation.

type DicomConfig

type DicomConfig struct {
	// FilterProfile: Tag filtering profile that determines which tags to
	// keep/remove.
	//
	// Possible values:
	//   "TAG_FILTER_PROFILE_UNSPECIFIED" - No tag filtration profile provided.
	// Same as KEEP_ALL_PROFILE.
	//   "MINIMAL_KEEP_LIST_PROFILE" - Keep only tags required to produce valid
	// DICOM.
	//   "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" - Inspects within tag contents and replaces
	// 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
	FilterProfile string `json:"filterProfile,omitempty"`
	// KeepList: List of tags to keep. Remove all other tags.
	KeepList *TagFilterList `json:"keepList,omitempty"`
	// RemoveList: List of tags to remove. Keep all other tags.
	RemoveList *TagFilterList `json:"removeList,omitempty"`
	// SkipIdRedaction: 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
	SkipIdRedaction bool `json:"skipIdRedaction,omitempty"`
	// ForceSendFields is a list of field names (e.g. "FilterProfile") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "FilterProfile") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (DicomConfig) MarshalJSON

func (s DicomConfig) MarshalJSON() ([]byte, error)

type DicomFilterConfig

type DicomFilterConfig struct {
	// ResourcePathsGcsUri: The Cloud Storage location of the filter configuration
	// file. The `gcs_uri` must be in the format `gs://bucket/path/to/object`. The
	// filter configuration file must contain a list of resource paths separated by
	// newline characters (\n or \r\n). Each resource path must be in the format
	// "/studies/{studyUID}[/series/{seriesUID}[/instances/{instanceUID}]]" The
	// Cloud Healthcare API service account must have the
	// `roles/storage.objectViewer` Cloud IAM role for this Cloud Storage location.
	ResourcePathsGcsUri string `json:"resourcePathsGcsUri,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ResourcePathsGcsUri") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ResourcePathsGcsUri") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

DicomFilterConfig: Specifies the filter configuration for DICOM resources.

func (DicomFilterConfig) MarshalJSON

func (s DicomFilterConfig) MarshalJSON() ([]byte, error)

type DicomStore

type DicomStore struct {
	// Labels: User-supplied key-value pairs used to organize DICOM 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.
	Labels map[string]string `json:"labels,omitempty"`
	// Name: Identifier. Resource name of the DICOM store, of the form
	// `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomSto
	// res/{dicom_store_id}`.
	Name string `json:"name,omitempty"`
	// NotificationConfig: Notification destination for new DICOM instances.
	// Supplied by the client.
	NotificationConfig *NotificationConfig `json:"notificationConfig,omitempty"`
	// StreamConfigs: Optional. A list of streaming configs used to configure the
	// destination of streaming exports for every DICOM instance insertion in this
	// DICOM store. After a new config is added to `stream_configs`, DICOM instance
	// insertions are streamed to the new destination. When a config is removed
	// from `stream_configs`, the server stops streaming to that destination. Each
	// config must contain a unique destination.
	StreamConfigs []*GoogleCloudHealthcareV1DicomStreamConfig `json:"streamConfigs,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Labels") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Labels") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

DicomStore: Represents a DICOM store.

func (DicomStore) MarshalJSON

func (s DicomStore) MarshalJSON() ([]byte, error)

type DicomStoreMetrics added in v0.147.0

type DicomStoreMetrics struct {
	// BlobStorageSizeBytes: Total blob storage bytes for all instances in the
	// store.
	BlobStorageSizeBytes int64 `json:"blobStorageSizeBytes,omitempty,string"`
	// InstanceCount: Number of instances in the store.
	InstanceCount int64 `json:"instanceCount,omitempty,string"`
	// Name: Resource name of the DICOM store, of the form
	// `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomSto
	// res/{dicom_store_id}`.
	Name string `json:"name,omitempty"`
	// SeriesCount: Number of series in the store.
	SeriesCount int64 `json:"seriesCount,omitempty,string"`
	// StructuredStorageSizeBytes: Total structured storage bytes for all instances
	// in the store.
	StructuredStorageSizeBytes int64 `json:"structuredStorageSizeBytes,omitempty,string"`
	// StudyCount: Number of studies in the store.
	StudyCount int64 `json:"studyCount,omitempty,string"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "BlobStorageSizeBytes") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "BlobStorageSizeBytes") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

DicomStoreMetrics: DicomStoreMetrics contains metrics describing a DICOM store.

func (DicomStoreMetrics) MarshalJSON added in v0.147.0

func (s DicomStoreMetrics) MarshalJSON() ([]byte, error)

type Empty

type Empty struct {
	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
}

Empty: A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

type EncryptionSpec added in v0.186.0

type EncryptionSpec struct {
	// KmsKeyName: Required. The resource name of customer-managed encryption key
	// that is used to secure a resource and its sub-resources. Only the key in the
	// same location as this Dataset is allowed to be used for encryption. Format
	// is:
	// `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`
	KmsKeyName string `json:"kmsKeyName,omitempty"`
	// ForceSendFields is a list of field names (e.g. "KmsKeyName") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "KmsKeyName") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

EncryptionSpec: Represents a customer-managed encryption key spec that can be applied to a resource.

func (EncryptionSpec) MarshalJSON added in v0.186.0

func (s EncryptionSpec) MarshalJSON() ([]byte, error)

type Entity added in v0.57.0

type Entity struct {
	// EntityId: entity_id is a first class field entity_id uniquely identifies
	// this concept and its meta-vocabulary. For example, "UMLS/C0000970".
	EntityId string `json:"entityId,omitempty"`
	// PreferredTerm: preferred_term is the preferred term for this concept. For
	// example, "Acetaminophen". For ad hoc entities formed by normalization, this
	// is the most popular unnormalized string.
	PreferredTerm string `json:"preferredTerm,omitempty"`
	// VocabularyCodes: Vocabulary codes are first-class fields and differentiated
	// from the concept unique identifier (entity_id). vocabulary_codes contains
	// the representation of this concept in particular vocabularies, such as
	// ICD-10, SNOMED-CT and RxNORM. These are prefixed by the name of the
	// vocabulary, followed by the unique code within that vocabulary. For example,
	// "RXNORM/A10334543".
	VocabularyCodes []string `json:"vocabularyCodes,omitempty"`
	// ForceSendFields is a list of field names (e.g. "EntityId") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "EntityId") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Entity: The candidate entities that an entity mention could link to.

func (Entity) MarshalJSON added in v0.57.0

func (s Entity) MarshalJSON() ([]byte, error)

type EntityMention added in v0.57.0

type EntityMention struct {
	// CertaintyAssessment: The certainty assessment of the entity mention. Its
	// value is one of: LIKELY, SOMEWHAT_LIKELY, UNCERTAIN, SOMEWHAT_UNLIKELY,
	// UNLIKELY, CONDITIONAL
	CertaintyAssessment *Feature `json:"certaintyAssessment,omitempty"`
	// Confidence: The model's confidence in this entity mention annotation. A
	// number between 0 and 1.
	Confidence float64 `json:"confidence,omitempty"`
	// LinkedEntities: linked_entities are candidate ontological concepts that this
	// entity mention may refer to. They are sorted by decreasing confidence.
	LinkedEntities []*LinkedEntity `json:"linkedEntities,omitempty"`
	// MentionId: mention_id uniquely identifies each entity mention in a single
	// response.
	MentionId string `json:"mentionId,omitempty"`
	// Subject: The subject this entity mention relates to. Its value is one of:
	// PATIENT, FAMILY_MEMBER, OTHER
	Subject *Feature `json:"subject,omitempty"`
	// TemporalAssessment: How this entity mention relates to the subject
	// temporally. Its value is one of: CURRENT, CLINICAL_HISTORY, FAMILY_HISTORY,
	// UPCOMING, ALLERGY
	TemporalAssessment *Feature `json:"temporalAssessment,omitempty"`
	// Text: text is the location of the entity mention in the document.
	Text *TextSpan `json:"text,omitempty"`
	// Type: The semantic type of the entity: UNKNOWN_ENTITY_TYPE, ALONE,
	// ANATOMICAL_STRUCTURE, ASSISTED_LIVING, BF_RESULT, BM_RESULT, BM_UNIT,
	// BM_VALUE, BODY_FUNCTION, BODY_MEASUREMENT, COMPLIANT, DOESNOT_FOLLOWUP,
	// FAMILY, FOLLOWSUP, LABORATORY_DATA, LAB_RESULT, LAB_UNIT, LAB_VALUE,
	// MEDICAL_DEVICE, MEDICINE, MED_DOSE, MED_DURATION, MED_FORM, MED_FREQUENCY,
	// MED_ROUTE, MED_STATUS, MED_STRENGTH, MED_TOTALDOSE, MED_UNIT, NON_COMPLIANT,
	// OTHER_LIVINGSTATUS, PROBLEM, PROCEDURE, PROCEDURE_RESULT, PROC_METHOD,
	// REASON_FOR_NONCOMPLIANCE, SEVERITY, SUBSTANCE_ABUSE, UNCLEAR_FOLLOWUP.
	Type string `json:"type,omitempty"`
	// ForceSendFields is a list of field names (e.g. "CertaintyAssessment") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "CertaintyAssessment") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

EntityMention: An entity mention in the document.

func (EntityMention) MarshalJSON added in v0.57.0

func (s EntityMention) MarshalJSON() ([]byte, error)

func (*EntityMention) UnmarshalJSON added in v0.57.0

func (s *EntityMention) UnmarshalJSON(data []byte) error

type EntityMentionRelationship added in v0.57.0

type EntityMentionRelationship struct {
	// Confidence: The model's confidence in this annotation. A number between 0
	// and 1.
	Confidence float64 `json:"confidence,omitempty"`
	// ObjectId: object_id is the id of the object entity mention.
	ObjectId string `json:"objectId,omitempty"`
	// SubjectId: subject_id is the id of the subject entity mention.
	SubjectId string `json:"subjectId,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Confidence") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Confidence") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

EntityMentionRelationship: Defines directed relationship from one entity mention to another.

func (EntityMentionRelationship) MarshalJSON added in v0.57.0

func (s EntityMentionRelationship) MarshalJSON() ([]byte, error)

func (*EntityMentionRelationship) UnmarshalJSON added in v0.57.0

func (s *EntityMentionRelationship) UnmarshalJSON(data []byte) error

type EvaluateUserConsentsRequest added in v0.41.0

type EvaluateUserConsentsRequest struct {
	// ConsentList: Optional. Specific Consents to evaluate the access request
	// against. These Consents must have the same `user_id` as the User data
	// mappings being evalauted, must exist in the current `consent_store`, and
	// must have a `state` of either `ACTIVE` or `DRAFT`. A maximum of 100 Consents
	// can be provided here. If unspecified, all `ACTIVE` unexpired Consents in the
	// current `consent_store` will be evaluated.
	ConsentList *ConsentList `json:"consentList,omitempty"`
	// PageSize: Optional. Limit on the number of User data mappings to return in a
	// single response. If not specified, 100 is used. May not be larger than 1000.
	PageSize int64 `json:"pageSize,omitempty"`
	// PageToken: Optional. Token to retrieve the next page of results, or empty to
	// get the first page.
	PageToken string `json:"pageToken,omitempty"`
	// RequestAttributes: Required. The values of request attributes associated
	// with this access request.
	RequestAttributes map[string]string `json:"requestAttributes,omitempty"`
	// ResourceAttributes: Optional. The values of resource attributes associated
	// with the resources being requested. If no values are specified, then all
	// resources are queried.
	ResourceAttributes map[string]string `json:"resourceAttributes,omitempty"`
	// ResponseView: Optional. The view for EvaluateUserConsentsResponse. If
	// unspecified, defaults to `BASIC` and returns `consented` as `TRUE` or
	// `FALSE`.
	//
	// Possible values:
	//   "RESPONSE_VIEW_UNSPECIFIED" - No response view specified. The API will
	// default to the BASIC view.
	//   "BASIC" - Only the `data_id` and `consented` fields are populated in the
	// response.
	//   "FULL" - All fields within the response are populated. When set to `FULL`,
	// all `ACTIVE` Consents are evaluated even if a matching policy is found
	// during evaluation.
	ResponseView string `json:"responseView,omitempty"`
	// UserId: Required. User ID to evaluate consents for.
	UserId string `json:"userId,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ConsentList") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ConsentList") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

EvaluateUserConsentsRequest: Evaluate a user's Consents for all matching User data mappings. Note: User data mappings are indexed asynchronously, causing slight delays between the time mappings are created or updated and when they are included in EvaluateUserConsents results.

func (EvaluateUserConsentsRequest) MarshalJSON added in v0.41.0

func (s EvaluateUserConsentsRequest) MarshalJSON() ([]byte, error)

type EvaluateUserConsentsResponse added in v0.41.0

type EvaluateUserConsentsResponse struct {
	// NextPageToken: Token to retrieve the next page of results, or empty if there
	// are no more results in the list. This token is valid for 72 hours after it
	// is created.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// Results: The consent evaluation result for each `data_id`.
	Results []*Result `json:"results,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "NextPageToken") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "NextPageToken") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

func (EvaluateUserConsentsResponse) MarshalJSON added in v0.41.0

func (s EvaluateUserConsentsResponse) MarshalJSON() ([]byte, error)

type ExportDicomDataRequest

type ExportDicomDataRequest struct {
	// BigqueryDestination: The BigQuery output destination. You can only export to
	// a BigQuery dataset that's in the same project as the DICOM store you're
	// exporting from. The Cloud Healthcare Service Agent requires two IAM roles on
	// the BigQuery location: `roles/bigquery.dataEditor` and
	// `roles/bigquery.jobUser`.
	BigqueryDestination *GoogleCloudHealthcareV1DicomBigQueryDestination `json:"bigqueryDestination,omitempty"`
	// GcsDestination: The Cloud Storage output destination. The Cloud Healthcare
	// Service Agent requires the `roles/storage.objectAdmin` Cloud IAM roles on
	// the Cloud Storage location.
	GcsDestination *GoogleCloudHealthcareV1DicomGcsDestination `json:"gcsDestination,omitempty"`
	// ForceSendFields is a list of field names (e.g. "BigqueryDestination") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "BigqueryDestination") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ExportDicomDataRequest: Exports data from the specified DICOM store. If a given resource, such as a DICOM object with the same SOPInstance UID, already exists in the output, it is overwritten with the version in the source dataset. Exported DICOM data persists when the DICOM store from which it was exported is deleted.

func (ExportDicomDataRequest) MarshalJSON

func (s ExportDicomDataRequest) MarshalJSON() ([]byte, error)

type ExportDicomDataResponse

type ExportDicomDataResponse struct {
}

ExportDicomDataResponse: Returns additional information in regards to a completed DICOM store export.

type ExportMessagesRequest added in v0.59.0

type ExportMessagesRequest struct {
	// EndTime: The end of the range in `send_time` (MSH.7,
	// https://www.hl7.org/documentcenter/public_temp_2E58C1F9-1C23-BA17-0C6126475344DA9D/wg/conf/HL7MSH.htm)
	// to process. If not specified, the time when the export is scheduled is used.
	// This value has to come after the `start_time` defined below. Only messages
	// whose `send_time` lies in the range `start_time` (inclusive) to `end_time`
	// (exclusive) are exported.
	EndTime string `json:"endTime,omitempty"`
	// Filter: Restricts messages exported to those matching a filter, only
	// applicable to PubsubDestination and GcsDestination. The following syntax is
	// available: * A string field value can be written as text inside quotation
	// marks, for example "query text". The only valid relational operation for
	// text fields is equality (`=`), where text is searched within the field,
	// rather than having the field be equal to the text. For example, "Comment =
	// great" returns messages with `great` in the comment field. * A number field
	// value can be written as an integer, a decimal, or an exponential. The valid
	// relational operators for number fields are the equality operator (`=`),
	// along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note
	// that there is no inequality (`!=`) operator. You can prepend the `NOT`
	// operator to an expression to negate it. * A date field value must be written
	// in the `yyyy-mm-dd` format. Fields with date and time use the RFC3339 time
	// format. Leading zeros are required for one-digit months and days. The valid
	// relational operators for date fields are the equality operator (`=`) , along
	// with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that
	// there is no inequality (`!=`) operator. You can prepend the `NOT` operator
	// to an expression to negate it. * Multiple field query expressions can be
	// combined in one query by adding `AND` or `OR` operators between the
	// expressions. If a boolean operator appears within a quoted string, it is not
	// treated as special, and is just another part of the character string to be
	// matched. You can prepend the `NOT` operator to an expression to negate it.
	// The following fields and functions are available for filtering: *
	// `message_type`, from the MSH-9.1 field. For example, `NOT message_type =
	// "ADT". * `send_date` or `sendDate`, the `yyyy-mm-dd` date the message was
	// sent in the dataset's time_zone, from the MSH-7 segment. For example,
	// `send_date < "2017-01-02". * `send_time`, the timestamp when the message
	// was sent, using the RFC3339 time format for comparisons, from the MSH-7
	// segment. For example, `send_time < "2017-01-02T00:00:00-05:00". *
	// `create_time`, the timestamp when the message was created in the HL7v2
	// store. Use the RFC3339 time format for comparisons. For example,
	// `create_time < "2017-01-02T00:00:00-05:00". * `send_facility`, the care
	// center that the message came from, from the MSH-4 segment. For example,
	// `send_facility = "ABC". Note: The filter will be applied to every message
	// in the HL7v2 store whose `send_time` lies in the range defined by the
	// `start_time` and the `end_time`. Even if the filter only matches a small set
	// of messages, the export operation can still take a long time to finish when
	// a lot of messages are between the specified `start_time` and `end_time`
	// range.
	Filter string `json:"filter,omitempty"`
	// GcsDestination: Export to a Cloud Storage destination.
	GcsDestination *GcsDestination `json:"gcsDestination,omitempty"`
	// PubsubDestination: Export messages to a Pub/Sub topic.
	PubsubDestination *PubsubDestination `json:"pubsubDestination,omitempty"`
	// StartTime: The start of the range in `send_time` (MSH.7,
	// https://www.hl7.org/documentcenter/public_temp_2E58C1F9-1C23-BA17-0C6126475344DA9D/wg/conf/HL7MSH.htm)
	// to process. If not specified, the UNIX epoch (1970-01-01T00:00:00Z) is used.
	// This value has to come before the `end_time` defined below. Only messages
	// whose `send_time` lies in the range `start_time` (inclusive) to `end_time`
	// (exclusive) are exported.
	StartTime string `json:"startTime,omitempty"`
	// ForceSendFields is a list of field names (e.g. "EndTime") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "EndTime") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ExportMessagesRequest: Request to schedule an export.

func (ExportMessagesRequest) MarshalJSON added in v0.59.0

func (s ExportMessagesRequest) MarshalJSON() ([]byte, error)

type ExportMessagesResponse added in v0.59.0

type ExportMessagesResponse struct {
}

ExportMessagesResponse: Final response for the export operation. This structure is included in the response to describe the detailed outcome.

type ExportResourcesRequest

type ExportResourcesRequest struct {
	// Since: If provided, only resources updated after this time are exported. The
	// time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. For example,
	// `2015-02-07T13:28:17.239+02:00` or `2017-01-01T00:00:00Z`. The time must be
	// specified to the second and include a time zone.
	Since string `json:"_since,omitempty"`
	// Type: String of comma-delimited FHIR resource types. If provided, only
	// resources of the specified resource type(s) are exported.
	Type string `json:"_type,omitempty"`
	// BigqueryDestination: The BigQuery output destination. The Cloud Healthcare
	// Service Agent requires two IAM roles on the BigQuery location:
	// `roles/bigquery.dataEditor` and `roles/bigquery.jobUser`. The output is one
	// BigQuery table per resource type. Unlike when setting `BigQueryDestination`
	// for `StreamConfig`, `ExportResources` does not create BigQuery views.
	BigqueryDestination *GoogleCloudHealthcareV1FhirBigQueryDestination `json:"bigqueryDestination,omitempty"`
	// GcsDestination: The Cloud Storage output destination. The Healthcare Service
	// Agent account requires the `roles/storage.objectAdmin` role on the Cloud
	// Storage location. The exported outputs are organized by FHIR resource types.
	// The server creates one object per resource type. Each object contains
	// newline delimited JSON, and each line is a FHIR resource.
	GcsDestination *GoogleCloudHealthcareV1FhirGcsDestination `json:"gcsDestination,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Since") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Since") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ExportResourcesRequest: Request to export resources.

func (ExportResourcesRequest) MarshalJSON

func (s ExportResourcesRequest) MarshalJSON() ([]byte, error)

type ExportResourcesResponse

type ExportResourcesResponse struct {
}

ExportResourcesResponse: Response when all resources export successfully. This structure is included in the response to describe the detailed outcome after the operation finishes successfully.

type Expr

type Expr struct {
	// Description: Optional. Description of the expression. This is a longer text
	// which describes the expression, e.g. when hovered over it in a UI.
	Description string `json:"description,omitempty"`
	// Expression: Textual representation of an expression in Common Expression
	// Language syntax.
	Expression string `json:"expression,omitempty"`
	// Location: Optional. String indicating the location of the expression for
	// error reporting, e.g. a file name and a position in the file.
	Location string `json:"location,omitempty"`
	// Title: Optional. Title for the expression, i.e. a short string describing
	// its purpose. This can be used e.g. in UIs which allow to enter the
	// expression.
	Title string `json:"title,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Description") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Description") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Expr: 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.

func (Expr) MarshalJSON

func (s Expr) MarshalJSON() ([]byte, error)

type Feature added in v0.57.0

type Feature struct {
	// Confidence: The model's confidence in this feature annotation. A number
	// between 0 and 1.
	Confidence float64 `json:"confidence,omitempty"`
	// Value: The value of this feature annotation. Its range depends on the type
	// of the feature.
	Value string `json:"value,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Confidence") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Confidence") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Feature: A feature of an entity mention.

func (Feature) MarshalJSON added in v0.57.0

func (s Feature) MarshalJSON() ([]byte, error)

func (*Feature) UnmarshalJSON added in v0.57.0

func (s *Feature) UnmarshalJSON(data []byte) error

type FhirConfig

type FhirConfig struct {
	// DefaultKeepExtensions: 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.
	DefaultKeepExtensions bool `json:"defaultKeepExtensions,omitempty"`
	// FieldMetadataList: 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`.
	FieldMetadataList []*FieldMetadata `json:"fieldMetadataList,omitempty"`
	// ForceSendFields is a list of field names (e.g. "DefaultKeepExtensions") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "DefaultKeepExtensions") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (FhirConfig) MarshalJSON

func (s FhirConfig) MarshalJSON() ([]byte, error)

type FhirFilter

type FhirFilter struct {
	// Resources: List of resources to include in the output. If this list is empty
	// or not specified, all resources are included in the output.
	Resources *Resources `json:"resources,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Resources") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Resources") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

FhirFilter: Filter configuration.

func (FhirFilter) MarshalJSON

func (s FhirFilter) MarshalJSON() ([]byte, error)

type FhirNotificationConfig added in v0.121.0

type FhirNotificationConfig struct {
	// PubsubTopic: The Pub/Sub (https://cloud.google.com/pubsub/docs/) 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 (https://cloud.google.com/pubsub/docs/overview#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
	// (https://cloud.google.com/healthcare-api/docs/how-tos/logging).
	PubsubTopic string `json:"pubsubTopic,omitempty"`
	// SendFullResource: Whether to send full FHIR resource to this Pub/Sub topic.
	// The default value is false.
	SendFullResource bool `json:"sendFullResource,omitempty"`
	// SendPreviousResourceOnDelete: Whether to send full FHIR resource to this
	// Pub/Sub topic for deleting FHIR resource. The default value is false. 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.
	SendPreviousResourceOnDelete bool `json:"sendPreviousResourceOnDelete,omitempty"`
	// ForceSendFields is a list of field names (e.g. "PubsubTopic") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "PubsubTopic") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

FhirNotificationConfig: Contains the configuration for FHIR notifications.

func (FhirNotificationConfig) MarshalJSON added in v0.121.0

func (s FhirNotificationConfig) MarshalJSON() ([]byte, error)

type FhirStore

type FhirStore struct {
	// ComplexDataTypeReferenceParsing: 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.
	//
	// Possible values:
	//   "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.
	ComplexDataTypeReferenceParsing string `json:"complexDataTypeReferenceParsing,omitempty"`
	// DefaultSearchHandlingStrict: 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`. Defaults to false.
	DefaultSearchHandlingStrict bool `json:"defaultSearchHandlingStrict,omitempty"`
	// DisableReferentialIntegrity: 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.
	DisableReferentialIntegrity bool `json:"disableReferentialIntegrity,omitempty"`
	// DisableResourceVersioning: 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, 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. Defaults to false.
	DisableResourceVersioning bool `json:"disableResourceVersioning,omitempty"`
	// EnableUpdateCreate: Whether this FHIR store has the updateCreate capability
	// (https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate).
	// 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. Defaults to false.
	EnableUpdateCreate bool `json:"enableUpdateCreate,omitempty"`
	// Labels: 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.
	Labels map[string]string `json:"labels,omitempty"`
	// Name: Output only. Identifier. Resource name of the FHIR store, of the form
	// `projects/{project_id}/locations/{location}/datasets/{dataset_id}/fhirStores/
	// {fhir_store_id}`.
	Name string `json:"name,omitempty"`
	// 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".
	NotificationConfig *NotificationConfig `json:"notificationConfig,omitempty"`
	// NotificationConfigs: Specifies where and whether to send notifications upon
	// changes to a FHIR store.
	NotificationConfigs []*FhirNotificationConfig `json:"notificationConfigs,omitempty"`
	// StreamConfigs: 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`
	// (https://cloud.google.com/bigquery/docs/access-control#bigquery.dataEditor)
	// role to your project's **Cloud Healthcare Service Agent** service account
	// (https://cloud.google.com/iam/docs/service-accounts). Some lag (typically on
	// the order of dozens of seconds) is expected before the results show up in
	// the streaming destination.
	StreamConfigs []*StreamConfig `json:"streamConfigs,omitempty"`
	// ValidationConfig: Configuration for how to validate incoming FHIR resources
	// against configured profiles.
	ValidationConfig *ValidationConfig `json:"validationConfig,omitempty"`
	// Version: Required. 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.
	//
	// Possible values:
	//   "VERSION_UNSPECIFIED" - Users must specify a version on store creation or
	// an error is returned.
	//   "DSTU2" - Draft Standard for Trial Use, [Release
	// 2](https://www.hl7.org/fhir/DSTU2)
	//   "STU3" - Standard for Trial Use, [Release
	// 3](https://www.hl7.org/fhir/STU3)
	//   "R4" - [Release 4](https://www.hl7.org/fhir/R4)
	Version string `json:"version,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g.
	// "ComplexDataTypeReferenceParsing") to unconditionally include in API
	// requests. By default, fields with empty or default values are omitted from
	// API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ComplexDataTypeReferenceParsing")
	// to include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

FhirStore: Represents a FHIR store.

func (FhirStore) MarshalJSON

func (s FhirStore) MarshalJSON() ([]byte, error)

type FhirStoreMetric added in v0.111.0

type FhirStoreMetric struct {
	// Count: The total count of FHIR resources in the store of this resource type.
	Count int64 `json:"count,omitempty,string"`
	// ResourceType: The FHIR resource type this metric applies to.
	ResourceType string `json:"resourceType,omitempty"`
	// StructuredStorageSizeBytes: The total amount of structured storage used by
	// FHIR resources of this resource type in the store.
	StructuredStorageSizeBytes int64 `json:"structuredStorageSizeBytes,omitempty,string"`
	// ForceSendFields is a list of field names (e.g. "Count") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Count") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

FhirStoreMetric: Count of resources and total storage size by type for a given FHIR store.

func (FhirStoreMetric) MarshalJSON added in v0.111.0

func (s FhirStoreMetric) MarshalJSON() ([]byte, error)

type FhirStoreMetrics added in v0.111.0

type FhirStoreMetrics struct {
	// Metrics: List of FhirStoreMetric by resource type.
	Metrics []*FhirStoreMetric `json:"metrics,omitempty"`
	// Name: The resource name of the FHIR store to get metrics for, in the format
	// `projects/{project_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`.
	Name string `json:"name,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Metrics") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Metrics") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

FhirStoreMetrics: List of metrics for a given FHIR store.

func (FhirStoreMetrics) MarshalJSON added in v0.111.0

func (s FhirStoreMetrics) MarshalJSON() ([]byte, error)

type Field added in v0.41.0

type Field struct {
	// MaxOccurs: The maximum number of times this field can be repeated. 0 or -1
	// means unbounded.
	MaxOccurs int64 `json:"maxOccurs,omitempty"`
	// MinOccurs: The minimum number of times this field must be present/repeated.
	MinOccurs int64 `json:"minOccurs,omitempty"`
	// Name: The name of the field. For example, "PID-1" or just "1".
	Name string `json:"name,omitempty"`
	// Table: The HL7v2 table this field refers to. For example, PID-15 (Patient's
	// Primary Language) usually refers to table "0296".
	Table string `json:"table,omitempty"`
	// Type: The type of this field. A Type with this name must be defined in an
	// Hl7TypesConfig.
	Type string `json:"type,omitempty"`
	// ForceSendFields is a list of field names (e.g. "MaxOccurs") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "MaxOccurs") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Field: A (sub) field of a type.

func (Field) MarshalJSON added in v0.41.0

func (s Field) MarshalJSON() ([]byte, error)

type FieldMetadata

type FieldMetadata struct {
	// Action: Deidentify action for one field.
	//
	// Possible values:
	//   "ACTION_UNSPECIFIED" - No action specified.
	//   "TRANSFORM" - Transform the entire field.
	//   "INSPECT_AND_TRANSFORM" - Inspect and transform any found PHI.
	//   "DO_NOT_TRANSFORM" - Do not transform.
	Action string `json:"action,omitempty"`
	// Paths: List of paths to FHIR fields to be redacted. Each path is a
	// period-separated list where each component is either a field name or FHIR
	// type name, for example: Patient, HumanName. For "choice" types (those
	// defined in the FHIR spec with the form: field[x]) we 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.
	Paths []string `json:"paths,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Action") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Action") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (FieldMetadata) MarshalJSON

func (s FieldMetadata) MarshalJSON() ([]byte, error)

type GcsDestination added in v0.59.0

type GcsDestination struct {
	// ContentStructure: The format of the exported HL7v2 message files.
	//
	// Possible values:
	//   "CONTENT_STRUCTURE_UNSPECIFIED" - If the content structure is not
	// specified, the default value `MESSAGE_JSON` will be used.
	//   "MESSAGE_JSON" - Messages are printed using the JSON format returned from
	// the `GetMessage` API. Messages are delimited with newlines.
	ContentStructure string `json:"contentStructure,omitempty"`
	// MessageView: Specifies the parts of the Message resource to include in the
	// export. If not specified, FULL is used.
	//
	// Possible values:
	//   "MESSAGE_VIEW_UNSPECIFIED" - Not specified, equivalent to FULL.
	//   "RAW_ONLY" - Server responses include all the message fields except
	// parsed_data field, and schematized_data fields.
	//   "PARSED_ONLY" - Server responses include all the message fields except
	// data field, and schematized_data fields.
	//   "FULL" - Server responses include all the message fields.
	//   "SCHEMATIZED_ONLY" - Server responses include all the message fields
	// except data and parsed_data fields.
	//   "BASIC" - Server responses include only the name field.
	MessageView string `json:"messageView,omitempty"`
	// UriPrefix: URI of an existing Cloud Storage directory where the server
	// writes result files, in the format
	// `gs://{bucket-id}/{path/to/destination/dir}`. If there is no trailing slash,
	// the service appends one when composing the object path.
	UriPrefix string `json:"uriPrefix,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ContentStructure") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ContentStructure") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GcsDestination: The Cloud Storage output destination. The Cloud Healthcare Service Agent requires the `roles/storage.objectAdmin` Cloud IAM roles on the Cloud Storage location.

func (GcsDestination) MarshalJSON added in v0.59.0

func (s GcsDestination) MarshalJSON() ([]byte, error)

type GcsSource added in v0.59.0

type GcsSource struct {
	// Uri: Points to a Cloud Storage URI containing file(s) to import. The URI
	// must be in the following format: `gs://{bucket_id}/{object_id}`. The URI can
	// include wildcards in `object_id` and thus identify multiple files. Supported
	// wildcards: * `*` to match 0 or more non-separator characters * `**` to match
	// 0 or more characters (including separators). Must be used at the end of a
	// path and with no other wildcards in the path. Can also be used with a file
	// extension (such as .ndjson), which imports all files with the extension in
	// the specified directory and its sub-directories. For example,
	// `gs://my-bucket/my-directory/**.ndjson` imports all files with `.ndjson`
	// extensions in `my-directory/` and its sub-directories. * `?` to match 1
	// character Files matching the wildcard are expected to contain content only,
	// no metadata.
	Uri string `json:"uri,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Uri") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Uri") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GcsSource: Specifies the configuration for importing data from Cloud Storage.

func (GcsSource) MarshalJSON added in v0.59.0

func (s GcsSource) MarshalJSON() ([]byte, error)

type GoogleCloudHealthcareV1ConsentGcsDestination added in v0.41.0

type GoogleCloudHealthcareV1ConsentGcsDestination struct {
	// UriPrefix: URI for a Cloud Storage directory where the server writes result
	// files, in the format `gs://{bucket-id}/{path/to/destination/dir}`. If there
	// is no trailing slash, the service appends one when composing the object
	// path. The user is responsible for creating the Cloud Storage bucket and
	// directory referenced in `uri_prefix`.
	UriPrefix string `json:"uriPrefix,omitempty"`
	// ForceSendFields is a list of field names (e.g. "UriPrefix") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "UriPrefix") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudHealthcareV1ConsentGcsDestination: The Cloud Storage location for export.

func (GoogleCloudHealthcareV1ConsentGcsDestination) MarshalJSON added in v0.41.0

type GoogleCloudHealthcareV1ConsentPolicy added in v0.41.0

type GoogleCloudHealthcareV1ConsentPolicy struct {
	// AuthorizationRule: Required. The request conditions to meet to grant access.
	// In addition to any supported comparison operators, authorization rules may
	// have `IN` operator as well as at most 10 logical operators that are limited
	// to `AND` (`&&`), `OR` (`||`).
	AuthorizationRule *Expr `json:"authorizationRule,omitempty"`
	// ResourceAttributes: The resources that this policy applies to. A resource is
	// a match if it matches all the attributes listed here. If empty, this policy
	// applies to all User data mappings for the given user.
	ResourceAttributes []*Attribute `json:"resourceAttributes,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AuthorizationRule") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AuthorizationRule") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (GoogleCloudHealthcareV1ConsentPolicy) MarshalJSON added in v0.41.0

func (s GoogleCloudHealthcareV1ConsentPolicy) MarshalJSON() ([]byte, error)

type GoogleCloudHealthcareV1DeidentifyDeidentifyDicomStoreSummary

type GoogleCloudHealthcareV1DeidentifyDeidentifyDicomStoreSummary struct {
}

GoogleCloudHealthcareV1DeidentifyDeidentifyDicomStoreSummary: Contains a summary of the DeidentifyDicomStore operation.

type GoogleCloudHealthcareV1DeidentifyDeidentifyFhirStoreSummary

type GoogleCloudHealthcareV1DeidentifyDeidentifyFhirStoreSummary struct {
}

GoogleCloudHealthcareV1DeidentifyDeidentifyFhirStoreSummary: Contains a summary of the DeidentifyFhirStore operation.

type GoogleCloudHealthcareV1DicomBigQueryDestination

type GoogleCloudHealthcareV1DicomBigQueryDestination struct {
	// Force: 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.
	Force bool `json:"force,omitempty"`
	// TableUri: BigQuery URI to a table, up to 2000 characters long, in the format
	// `bq://projectId.bqDatasetId.tableId`
	TableUri string `json:"tableUri,omitempty"`
	// WriteDisposition: Determines whether the existing table in the destination
	// is to be overwritten or appended to. If a write_disposition is specified,
	// the `force` parameter is ignored.
	//
	// Possible values:
	//   "WRITE_DISPOSITION_UNSPECIFIED" - Default behavior is the same as
	// WRITE_EMPTY.
	//   "WRITE_EMPTY" - Only export data if the destination table is empty.
	//   "WRITE_TRUNCATE" - Erase all existing data in the destination table before
	// writing the instances.
	//   "WRITE_APPEND" - Append data to the destination table.
	WriteDisposition string `json:"writeDisposition,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Force") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Force") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudHealthcareV1DicomBigQueryDestination: The BigQuery table where the server writes the output.

func (GoogleCloudHealthcareV1DicomBigQueryDestination) MarshalJSON

type GoogleCloudHealthcareV1DicomGcsDestination

type GoogleCloudHealthcareV1DicomGcsDestination struct {
	// MimeType: MIME types supported by DICOM spec. Each file is written in the
	// following format:
	// `.../{study_id}/{series_id}/{instance_id}[/{frame_number}].{extension}` The
	// frame_number component exists only for multi-frame instances. Supported MIME
	// types are consistent with supported formats in DICOMweb:
	// https://cloud.google.com/healthcare/docs/dicom#retrieve_transaction.
	// Specifically, the following are supported: - application/dicom;
	// transfer-syntax=1.2.840.10008.1.2.1 (uncompressed DICOM) -
	// application/dicom; transfer-syntax=1.2.840.10008.1.2.4.50 (DICOM with
	// embedded JPEG Baseline) - application/dicom;
	// transfer-syntax=1.2.840.10008.1.2.4.90 (DICOM with embedded JPEG 2000
	// Lossless Only) - application/dicom; transfer-syntax=1.2.840.10008.1.2.4.91
	// (DICOM with embedded JPEG 2000) - application/dicom; transfer-syntax=*
	// (DICOM with no transcoding) - application/octet-stream;
	// transfer-syntax=1.2.840.10008.1.2.1 (raw uncompressed PixelData) -
	// application/octet-stream; transfer-syntax=* (raw PixelData in whatever
	// format it was uploaded in) - image/jpeg;
	// transfer-syntax=1.2.840.10008.1.2.4.50 (Consumer JPEG) - image/png The
	// following extensions are used for output files: - application/dicom -> .dcm
	// - image/jpeg -> .jpg - image/png -> .png - application/octet-stream -> no
	// extension If unspecified, the instances are exported in the original DICOM
	// format they were uploaded in.
	MimeType string `json:"mimeType,omitempty"`
	// UriPrefix: The Cloud Storage destination to export to. URI for a Cloud
	// Storage directory where the server writes the result files, in the format
	// `gs://{bucket-id}/{path/to/destination/dir}`). If there is no trailing
	// slash, the service appends one when composing the object path. The user is
	// responsible for creating the Cloud Storage bucket referenced in
	// `uri_prefix`.
	UriPrefix string `json:"uriPrefix,omitempty"`
	// ForceSendFields is a list of field names (e.g. "MimeType") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "MimeType") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudHealthcareV1DicomGcsDestination: The Cloud Storage location where the server writes the output and the export configuration.

func (GoogleCloudHealthcareV1DicomGcsDestination) MarshalJSON

type GoogleCloudHealthcareV1DicomGcsSource

type GoogleCloudHealthcareV1DicomGcsSource struct {
	// Uri: Points to a Cloud Storage URI containing file(s) with content only. The
	// URI must be in the following format: `gs://{bucket_id}/{object_id}`. The URI
	// can include wildcards in `object_id` and thus identify multiple files.
	// Supported wildcards: * '*' to match 0 or more non-separator characters *
	// '**' to match 0 or more characters (including separators). Must be used at
	// the end of a path and with no other wildcards in the path. Can also be used
	// with a file extension (such as .dcm), which imports all files with the
	// extension in the specified directory and its sub-directories. For example,
	// `gs://my-bucket/my-directory/**.dcm` imports all files with .dcm extensions
	// in `my-directory/` and its sub-directories. * '?' to match 1 character. All
	// other URI formats are invalid. Files matching the wildcard are expected to
	// contain content only, no metadata.
	Uri string `json:"uri,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Uri") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Uri") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudHealthcareV1DicomGcsSource: Specifies the configuration for importing data from Cloud Storage.

func (GoogleCloudHealthcareV1DicomGcsSource) MarshalJSON

func (s GoogleCloudHealthcareV1DicomGcsSource) MarshalJSON() ([]byte, error)

type GoogleCloudHealthcareV1DicomStreamConfig added in v0.131.0

type GoogleCloudHealthcareV1DicomStreamConfig struct {
	// BigqueryDestination: Results are appended to this table. The server creates
	// a new table in the given BigQuery dataset if the specified table does not
	// exist. To enable the Cloud Healthcare API to write to your BigQuery table,
	// you must give the Cloud Healthcare API service account the
	// bigquery.dataEditor role. The service account is:
	// `service-{PROJECT_NUMBER}@gcp-sa-healthcare.iam.gserviceaccount.com`. The
	// PROJECT_NUMBER identifies the project that the DICOM store resides in. To
	// get the project number, go to the Cloud Console Dashboard. It is recommended
	// to not have a custom schema in the destination table which could conflict
	// with the schema created by the Cloud Healthcare API. Instance deletions are
	// not applied to the destination table. The destination's table schema will be
	// automatically updated in case a new instance's data is incompatible with the
	// current schema. The schema should not be updated manually as this can cause
	// incompatibilies that cannot be resolved automatically. 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 instance that generates more than 1 MB of BigQuery data will
	// not be streamed. If an instance cannot be streamed to BigQuery, errors will
	// be logged to Cloud Logging (see Viewing error logs in Cloud Logging
	// (https://cloud.google.com/healthcare/docs/how-tos/logging)).
	BigqueryDestination *GoogleCloudHealthcareV1DicomBigQueryDestination `json:"bigqueryDestination,omitempty"`
	// ForceSendFields is a list of field names (e.g. "BigqueryDestination") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "BigqueryDestination") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudHealthcareV1DicomStreamConfig: StreamConfig specifies configuration for a streaming DICOM export.

func (GoogleCloudHealthcareV1DicomStreamConfig) MarshalJSON added in v0.131.0

type GoogleCloudHealthcareV1FhirBigQueryDestination

type GoogleCloudHealthcareV1FhirBigQueryDestination struct {
	// DatasetUri: BigQuery URI to an existing dataset, up to 2000 characters long,
	// in the format `bq://projectId.bqDatasetId`.
	DatasetUri string `json:"datasetUri,omitempty"`
	// Force: The default value is false. If this flag is `TRUE`, all tables are
	// deleted from the dataset before the new exported tables are written. If the
	// flag is not set and the destination dataset contains tables, the export call
	// returns an error. 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.
	Force bool `json:"force,omitempty"`
	// SchemaConfig: The configuration for the exported BigQuery schema.
	SchemaConfig *SchemaConfig `json:"schemaConfig,omitempty"`
	// WriteDisposition: 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.
	//
	// Possible values:
	//   "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.
	WriteDisposition string `json:"writeDisposition,omitempty"`
	// ForceSendFields is a list of field names (e.g. "DatasetUri") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "DatasetUri") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudHealthcareV1FhirBigQueryDestination: The configuration for exporting to BigQuery.

func (GoogleCloudHealthcareV1FhirBigQueryDestination) MarshalJSON

type GoogleCloudHealthcareV1FhirGcsDestination

type GoogleCloudHealthcareV1FhirGcsDestination struct {
	// UriPrefix: URI for a Cloud Storage directory where result files should be
	// written, in the format of `gs://{bucket-id}/{path/to/destination/dir}`. If
	// there is no trailing slash, the service appends one when composing the
	// object path. The user is responsible for creating the Cloud Storage bucket
	// referenced in `uri_prefix`.
	UriPrefix string `json:"uriPrefix,omitempty"`
	// ForceSendFields is a list of field names (e.g. "UriPrefix") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "UriPrefix") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudHealthcareV1FhirGcsDestination: The configuration for exporting to Cloud Storage.

func (GoogleCloudHealthcareV1FhirGcsDestination) MarshalJSON

type GoogleCloudHealthcareV1FhirGcsSource

type GoogleCloudHealthcareV1FhirGcsSource struct {
	// Uri: Points to a Cloud Storage URI containing file(s) to import. The URI
	// must be in the following format: `gs://{bucket_id}/{object_id}`. The URI can
	// include wildcards in `object_id` and thus identify multiple files. Supported
	// wildcards: * `*` to match 0 or more non-separator characters * `**` to match
	// 0 or more characters (including separators). Must be used at the end of a
	// path and with no other wildcards in the path. Can also be used with a file
	// extension (such as .ndjson), which imports all files with the extension in
	// the specified directory and its sub-directories. For example,
	// `gs://my-bucket/my-directory/**.ndjson` imports all files with `.ndjson`
	// extensions in `my-directory/` and its sub-directories. * `?` to match 1
	// character Files matching the wildcard are expected to contain content only,
	// no metadata.
	Uri string `json:"uri,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Uri") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Uri") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudHealthcareV1FhirGcsSource: Specifies the configuration for importing data from Cloud Storage.

func (GoogleCloudHealthcareV1FhirGcsSource) MarshalJSON

func (s GoogleCloudHealthcareV1FhirGcsSource) MarshalJSON() ([]byte, error)

type GroupOrSegment added in v0.41.0

type GroupOrSegment struct {
	Group   *SchemaGroup   `json:"group,omitempty"`
	Segment *SchemaSegment `json:"segment,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Group") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Group") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GroupOrSegment: Construct representing a logical group or a segment.

func (GroupOrSegment) MarshalJSON added in v0.41.0

func (s GroupOrSegment) MarshalJSON() ([]byte, error)

type Hl7SchemaConfig added in v0.41.0

type Hl7SchemaConfig struct {
	// MessageSchemaConfigs: Map from each HL7v2 message type and trigger event
	// pair, such as ADT_A04, to its schema configuration root group.
	MessageSchemaConfigs map[string]SchemaGroup `json:"messageSchemaConfigs,omitempty"`
	// Version: Each VersionSource is tested and only if they all match is the
	// schema used for the message.
	Version []*VersionSource `json:"version,omitempty"`
	// ForceSendFields is a list of field names (e.g. "MessageSchemaConfigs") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "MessageSchemaConfigs") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Hl7SchemaConfig: 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.

func (Hl7SchemaConfig) MarshalJSON added in v0.41.0

func (s Hl7SchemaConfig) MarshalJSON() ([]byte, error)

type Hl7TypesConfig added in v0.41.0

type Hl7TypesConfig struct {
	// Type: The HL7v2 type definitions.
	Type []*Type `json:"type,omitempty"`
	// Version: The version selectors that this config applies to. A message must
	// match ALL version sources to apply.
	Version []*VersionSource `json:"version,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Type") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Type") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (Hl7TypesConfig) MarshalJSON added in v0.41.0

func (s Hl7TypesConfig) MarshalJSON() ([]byte, error)

type Hl7V2NotificationConfig

type Hl7V2NotificationConfig struct {
	// Filter: Restricts notifications sent for messages matching a filter. If this
	// is empty, all messages are matched. The following syntax is available: * A
	// string field value can be written as text inside quotation marks, for
	// example "query text". The only valid relational operation for text fields
	// is equality (`=`), where text is searched within the field, rather than
	// having the field be equal to the text. For example, "Comment = great"
	// returns messages with `great` in the comment field. * A number field value
	// can be written as an integer, a decimal, or an exponential. The valid
	// relational operators for number fields are the equality operator (`=`),
	// along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note
	// that there is no inequality (`!=`) operator. You can prepend the `NOT`
	// operator to an expression to negate it. * A date field value must be written
	// in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format.
	// Leading zeros are required for one-digit months and days. The valid
	// relational operators for date fields are the equality operator (`=`) , along
	// with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that
	// there is no inequality (`!=`) operator. You can prepend the `NOT` operator
	// to an expression to negate it. * Multiple field query expressions can be
	// combined in one query by adding `AND` or `OR` operators between the
	// expressions. If a boolean operator appears within a quoted string, it is not
	// treated as special, it's just another part of the character string to be
	// matched. You can prepend the `NOT` operator to an expression to negate it.
	// The following fields and functions are available for filtering: *
	// `message_type`, from the MSH-9.1 field. For example, `NOT message_type =
	// "ADT". * `send_date` or `sendDate`, the YYYY-MM-DD date the message was
	// sent in the dataset's time_zone, from the MSH-7 segment. For example,
	// `send_date < "2017-01-02". * `send_time`, the timestamp when the message
	// was sent, using the RFC3339 time format for comparisons, from the MSH-7
	// segment. For example, `send_time < "2017-01-02T00:00:00-05:00". *
	// `create_time`, the timestamp when the message was created in the HL7v2
	// store. Use the RFC3339 time format for comparisons. For example,
	// `create_time < "2017-01-02T00:00:00-05:00". * `send_facility`, the care
	// center that the message came from, from the MSH-4 segment. For example,
	// `send_facility = "ABC". * `PatientId(value, type)`, which matches if the
	// message lists a patient having an ID of the given value and type in the
	// PID-2, PID-3, or PID-4 segments. For example, `PatientId("123456", "MRN")`.
	// * `labels.x`, a string value of the label with key `x` as set using the
	// Message.labels map. For example, `labels."priority"="high". The operator
	// `:*` can be used to assert the existence of a label. For example,
	// `labels."priority":*`.
	Filter string `json:"filter,omitempty"`
	// PubsubTopic: The Pub/Sub (https://cloud.google.com/pubsub/docs/) 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's 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 (https://cloud.google.com/pubsub/docs/overview#names) must be
	// scoped to a project. The Cloud Healthcare API service account,
	// service-PROJECT_NUMBER@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. If a
	// notification cannot be published to Pub/Sub, errors are logged to Cloud
	// Logging. For more information, see Viewing error logs in Cloud Logging
	// (https://cloud.google.com/healthcare/docs/how-tos/logging)).
	PubsubTopic string `json:"pubsubTopic,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Filter") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Filter") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (Hl7V2NotificationConfig) MarshalJSON

func (s Hl7V2NotificationConfig) MarshalJSON() ([]byte, error)

type Hl7V2Store

type Hl7V2Store struct {
	// Labels: User-supplied key-value pairs used to organize HL7v2 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.
	Labels map[string]string `json:"labels,omitempty"`
	// Name: Identifier. Resource name of the HL7v2 store, of the form
	// `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Sto
	// res/{hl7v2_store_id}`.
	Name string `json:"name,omitempty"`
	// NotificationConfigs: A list of notification configs. Each configuration uses
	// a filter to determine whether to publish a message (both Ingest & Create) on
	// the corresponding notification destination. Only the message name is sent as
	// part of the notification. Supplied by the client.
	NotificationConfigs []*Hl7V2NotificationConfig `json:"notificationConfigs,omitempty"`
	// ParserConfig: The configuration for the parser. It determines how the server
	// parses the messages.
	ParserConfig *ParserConfig `json:"parserConfig,omitempty"`
	// RejectDuplicateMessage: Determines whether to reject duplicate messages. A
	// duplicate message is a message with the same raw bytes as a message that has
	// already been ingested/created in this HL7v2 store. The default value is
	// false, meaning that the store accepts the duplicate messages and it also
	// returns the same ACK message in the IngestMessageResponse as has been
	// returned previously. Note that only one resource is created in the store.
	// When this field is set to true, CreateMessage/IngestMessage requests with a
	// duplicate message will be rejected by the store, and
	// IngestMessageErrorDetail returns a NACK message upon rejection.
	RejectDuplicateMessage bool `json:"rejectDuplicateMessage,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Labels") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Labels") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Hl7V2Store: Represents an HL7v2 store.

func (Hl7V2Store) MarshalJSON

func (s Hl7V2Store) MarshalJSON() ([]byte, error)

type Hl7V2StoreMetric added in v0.147.0

type Hl7V2StoreMetric struct {
	// Count: The total count of HL7v2 messages in the store for the given message
	// type.
	Count int64 `json:"count,omitempty,string"`
	// MessageType: The Hl7v2 message type this metric applies to, such as `ADT` or
	// `ORU`.
	MessageType string `json:"messageType,omitempty"`
	// StructuredStorageSizeBytes: The total amount of structured storage used by
	// HL7v2 messages of this message type in the store.
	StructuredStorageSizeBytes int64 `json:"structuredStorageSizeBytes,omitempty,string"`
	// ForceSendFields is a list of field names (e.g. "Count") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Count") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Hl7V2StoreMetric: Count of messages and total storage size by type for a given HL7 store.

func (Hl7V2StoreMetric) MarshalJSON added in v0.147.0

func (s Hl7V2StoreMetric) MarshalJSON() ([]byte, error)

type Hl7V2StoreMetrics added in v0.147.0

type Hl7V2StoreMetrics struct {
	// Metrics: List of HL7v2 store metrics by message type.
	Metrics []*Hl7V2StoreMetric `json:"metrics,omitempty"`
	// Name: The resource name of the HL7v2 store to get metrics for, in the format
	// `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`.
	Name string `json:"name,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Metrics") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Metrics") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Hl7V2StoreMetrics: List of metrics for a given HL7v2 store.

func (Hl7V2StoreMetrics) MarshalJSON added in v0.147.0

func (s Hl7V2StoreMetrics) MarshalJSON() ([]byte, error)

type HttpBody

type HttpBody struct {
	// ContentType: The HTTP Content-Type header value specifying the content type
	// of the body.
	ContentType string `json:"contentType,omitempty"`
	// Data: The HTTP request/response body as raw binary.
	Data string `json:"data,omitempty"`
	// Extensions: Application specific response metadata. Must be set in the first
	// response for streaming APIs.
	Extensions []googleapi.RawMessage `json:"extensions,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "ContentType") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ContentType") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

HttpBody: Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.

func (HttpBody) MarshalJSON

func (s HttpBody) MarshalJSON() ([]byte, error)

type Image added in v0.41.0

type Image struct {
	// GcsUri: Input only. Points to a Cloud Storage URI containing the consent
	// artifact content. The URI must be in the following format:
	// `gs://{bucket_id}/{object_id}`. The Cloud Healthcare API service account
	// must have the `roles/storage.objectViewer` Cloud IAM role for this Cloud
	// Storage location. The consent artifact content at this URI is copied to a
	// Cloud Storage location managed by the Cloud Healthcare API. Responses to
	// fetching requests return the consent artifact content in raw_bytes.
	GcsUri string `json:"gcsUri,omitempty"`
	// RawBytes: Consent artifact content represented as a stream of bytes. This
	// field is populated when returned in GetConsentArtifact response, but not
	// included in CreateConsentArtifact and ListConsentArtifact response.
	RawBytes string `json:"rawBytes,omitempty"`
	// ForceSendFields is a list of field names (e.g. "GcsUri") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "GcsUri") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Image: Raw bytes representing consent artifact content.

func (Image) MarshalJSON added in v0.41.0

func (s Image) MarshalJSON() ([]byte, error)

type ImageConfig

type ImageConfig struct {
	// TextRedactionMode: Determines how to redact text from image.
	//
	// Possible values:
	//   "TEXT_REDACTION_MODE_UNSPECIFIED" - No text redaction specified. Same as
	// REDACT_NO_TEXT.
	//   "REDACT_ALL_TEXT" - Redact all text.
	//   "REDACT_SENSITIVE_TEXT" - Redact sensitive text. Uses the set of [Default
	// DICOM
	// InfoTypes](https://cloud.google.com/healthcare-api/docs/how-tos/dicom-deident
	// ify#default_dicom_infotypes).
	//   "REDACT_NO_TEXT" - Do not redact text.
	TextRedactionMode string `json:"textRedactionMode,omitempty"`
	// ForceSendFields is a list of field names (e.g. "TextRedactionMode") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "TextRedactionMode") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ImageConfig: Specifies how to handle de-identification of image pixels.

func (ImageConfig) MarshalJSON

func (s ImageConfig) MarshalJSON() ([]byte, error)

type ImportDicomDataRequest

type ImportDicomDataRequest struct {
	// GcsSource: Cloud Storage source data location and import configuration. The
	// Cloud Healthcare Service Agent requires the `roles/storage.objectViewer`
	// Cloud IAM roles on the Cloud Storage location.
	GcsSource *GoogleCloudHealthcareV1DicomGcsSource `json:"gcsSource,omitempty"`
	// ForceSendFields is a list of field names (e.g. "GcsSource") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "GcsSource") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ImportDicomDataRequest: Imports data into the specified DICOM store. Returns an error if any of the files to import are not DICOM files. This API accepts duplicate DICOM instances by ignoring the newly-pushed instance. It does not overwrite.

func (ImportDicomDataRequest) MarshalJSON

func (s ImportDicomDataRequest) MarshalJSON() ([]byte, error)

type ImportDicomDataResponse

type ImportDicomDataResponse struct {
}

ImportDicomDataResponse: Returns additional information in regards to a completed DICOM store import.

type ImportMessagesRequest added in v0.59.0

type ImportMessagesRequest struct {
	// GcsSource: Cloud Storage source data location and import configuration. The
	// Cloud Healthcare Service Agent requires the `roles/storage.objectViewer`
	// Cloud IAM roles on the Cloud Storage location.
	GcsSource *GcsSource `json:"gcsSource,omitempty"`
	// ForceSendFields is a list of field names (e.g. "GcsSource") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "GcsSource") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ImportMessagesRequest: Request to import messages.

func (ImportMessagesRequest) MarshalJSON added in v0.59.0

func (s ImportMessagesRequest) MarshalJSON() ([]byte, error)

type ImportMessagesResponse added in v0.59.0

type ImportMessagesResponse struct {
}

ImportMessagesResponse: Final response of importing messages. This structure is included in the response to describe the detailed outcome. It is only included when the operation finishes successfully.

type ImportResourcesRequest

type ImportResourcesRequest struct {
	// ContentStructure: The content structure in the source location. If not
	// specified, the server treats the input source files as BUNDLE.
	//
	// Possible values:
	//   "CONTENT_STRUCTURE_UNSPECIFIED" - If the content structure is not
	// specified, the default value `BUNDLE` is used.
	//   "BUNDLE" - The source file contains one or more lines of newline-delimited
	// JSON (ndjson). Each line is a bundle that contains one or more resources.
	//   "RESOURCE" - The source file contains one or more lines of
	// newline-delimited JSON (ndjson). Each line is a single resource.
	//   "BUNDLE_PRETTY" - The entire file is one JSON bundle. The JSON can span
	// multiple lines.
	//   "RESOURCE_PRETTY" - The entire file is one JSON resource. The JSON can
	// span multiple lines.
	ContentStructure string `json:"contentStructure,omitempty"`
	// GcsSource: Cloud Storage source data location and import configuration. The
	// Healthcare Service Agent account requires the `roles/storage.objectAdmin`
	// role on the Cloud Storage location. Each Cloud Storage object should be a
	// text file that contains the format specified in ContentStructure.
	GcsSource *GoogleCloudHealthcareV1FhirGcsSource `json:"gcsSource,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ContentStructure") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ContentStructure") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ImportResourcesRequest: Request to import resources.

func (ImportResourcesRequest) MarshalJSON

func (s ImportResourcesRequest) MarshalJSON() ([]byte, error)

type ImportResourcesResponse

type ImportResourcesResponse struct {
}

ImportResourcesResponse: Final response of importing resources. This structure is included in the response to describe the detailed outcome after the operation finishes successfully.

type InfoTypeTransformation

type InfoTypeTransformation struct {
	// CharacterMaskConfig: Config for character mask.
	CharacterMaskConfig *CharacterMaskConfig `json:"characterMaskConfig,omitempty"`
	// CryptoHashConfig: Config for crypto hash.
	CryptoHashConfig *CryptoHashConfig `json:"cryptoHashConfig,omitempty"`
	// DateShiftConfig: Config for date shift.
	DateShiftConfig *DateShiftConfig `json:"dateShiftConfig,omitempty"`
	// InfoTypes: InfoTypes to apply this transformation to. If this is not
	// specified, the transformation applies to any info_type.
	InfoTypes []string `json:"infoTypes,omitempty"`
	// RedactConfig: Config for text redaction.
	RedactConfig *RedactConfig `json:"redactConfig,omitempty"`
	// ReplaceWithInfoTypeConfig: Config for replace with InfoType.
	ReplaceWithInfoTypeConfig *ReplaceWithInfoTypeConfig `json:"replaceWithInfoTypeConfig,omitempty"`
	// ForceSendFields is a list of field names (e.g. "CharacterMaskConfig") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "CharacterMaskConfig") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (InfoTypeTransformation) MarshalJSON

func (s InfoTypeTransformation) MarshalJSON() ([]byte, error)

type IngestMessageRequest

type IngestMessageRequest struct {
	// Message: Required. HL7v2 message to ingest.
	Message *Message `json:"message,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Message") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Message") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

IngestMessageRequest: Ingests a message into the specified HL7v2 store.

func (IngestMessageRequest) MarshalJSON

func (s IngestMessageRequest) MarshalJSON() ([]byte, error)

type IngestMessageResponse

type IngestMessageResponse struct {
	// Hl7Ack: HL7v2 ACK message.
	Hl7Ack string `json:"hl7Ack,omitempty"`
	// Message: Created message resource.
	Message *Message `json:"message,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Hl7Ack") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Hl7Ack") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

IngestMessageResponse: Acknowledges that a message has been ingested into the specified HL7v2 store.

func (IngestMessageResponse) MarshalJSON

func (s IngestMessageResponse) MarshalJSON() ([]byte, error)

type KmsWrappedCryptoKey added in v0.98.0

type KmsWrappedCryptoKey struct {
	// CryptoKey: Required. The resource name of the KMS CryptoKey to use for
	// unwrapping. For example,
	// `projects/{project_id}/locations/{location_id}/keyRings/{keyring}/cryptoKeys/
	// {key}`.
	CryptoKey string `json:"cryptoKey,omitempty"`
	// WrappedKey: Required. The wrapped data crypto key.
	WrappedKey string `json:"wrappedKey,omitempty"`
	// ForceSendFields is a list of field names (e.g. "CryptoKey") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "CryptoKey") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (KmsWrappedCryptoKey) MarshalJSON added in v0.98.0

func (s KmsWrappedCryptoKey) MarshalJSON() ([]byte, error)

type LinkedEntity added in v0.57.0

type LinkedEntity struct {
	// EntityId: entity_id is a concept unique identifier. These are prefixed by a
	// string that identifies the entity coding system, followed by the unique
	// identifier within that system. For example, "UMLS/C0000970". This also
	// supports ad hoc entities, which are formed by normalizing entity mention
	// content.
	EntityId string `json:"entityId,omitempty"`
	// ForceSendFields is a list of field names (e.g. "EntityId") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "EntityId") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

LinkedEntity: EntityMentions can be linked to multiple entities using a LinkedEntity message lets us add other fields, e.g. confidence.

func (LinkedEntity) MarshalJSON added in v0.57.0

func (s LinkedEntity) MarshalJSON() ([]byte, error)

type ListAttributeDefinitionsResponse added in v0.41.0

type ListAttributeDefinitionsResponse struct {
	// AttributeDefinitions: The returned Attribute definitions. The maximum number
	// of attributes returned is determined by the value of page_size in the
	// ListAttributeDefinitionsRequest.
	AttributeDefinitions []*AttributeDefinition `json:"attributeDefinitions,omitempty"`
	// NextPageToken: Token to retrieve the next page of results, or empty if there
	// are no more results in the list.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "AttributeDefinitions") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AttributeDefinitions") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

func (ListAttributeDefinitionsResponse) MarshalJSON added in v0.41.0

func (s ListAttributeDefinitionsResponse) MarshalJSON() ([]byte, error)

type ListConsentArtifactsResponse added in v0.41.0

type ListConsentArtifactsResponse struct {
	// ConsentArtifacts: The returned Consent artifacts. The maximum number of
	// artifacts returned is determined by the value of page_size in the
	// ListConsentArtifactsRequest.
	ConsentArtifacts []*ConsentArtifact `json:"consentArtifacts,omitempty"`
	// NextPageToken: Token to retrieve the next page of results, or empty if there
	// are no more results in the list.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "ConsentArtifacts") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ConsentArtifacts") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

func (ListConsentArtifactsResponse) MarshalJSON added in v0.41.0

func (s ListConsentArtifactsResponse) MarshalJSON() ([]byte, error)

type ListConsentRevisionsResponse added in v0.41.0

type ListConsentRevisionsResponse struct {
	// Consents: The returned Consent revisions. The maximum number of revisions
	// returned is determined by the value of `page_size` in the
	// ListConsentRevisionsRequest.
	Consents []*Consent `json:"consents,omitempty"`
	// NextPageToken: Token to retrieve the next page of results, or empty if there
	// are no more results in the list.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Consents") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Consents") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

func (ListConsentRevisionsResponse) MarshalJSON added in v0.41.0

func (s ListConsentRevisionsResponse) MarshalJSON() ([]byte, error)

type ListConsentStoresResponse added in v0.41.0

type ListConsentStoresResponse struct {
	// ConsentStores: The returned consent stores. The maximum number of stores
	// returned is determined by the value of page_size in the
	// ListConsentStoresRequest.
	ConsentStores []*ConsentStore `json:"consentStores,omitempty"`
	// NextPageToken: Token to retrieve the next page of results, or empty if there
	// are no more results in the list.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "ConsentStores") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ConsentStores") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

func (ListConsentStoresResponse) MarshalJSON added in v0.41.0

func (s ListConsentStoresResponse) MarshalJSON() ([]byte, error)

type ListConsentsResponse added in v0.41.0

type ListConsentsResponse struct {
	// Consents: The returned Consents. The maximum number of Consents returned is
	// determined by the value of page_size in the ListConsentsRequest.
	Consents []*Consent `json:"consents,omitempty"`
	// NextPageToken: Token to retrieve the next page of results, or empty if there
	// are no more results in the list.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Consents") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Consents") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

func (ListConsentsResponse) MarshalJSON added in v0.41.0

func (s ListConsentsResponse) MarshalJSON() ([]byte, error)

type ListDatasetsResponse

type ListDatasetsResponse struct {
	// Datasets: The first page of datasets.
	Datasets []*Dataset `json:"datasets,omitempty"`
	// NextPageToken: Token to retrieve the next page of results, or empty if there
	// are no more results in the list.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Datasets") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Datasets") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListDatasetsResponse: Lists the available datasets.

func (ListDatasetsResponse) MarshalJSON

func (s ListDatasetsResponse) MarshalJSON() ([]byte, error)

type ListDicomStoresResponse

type ListDicomStoresResponse struct {
	// DicomStores: The returned DICOM stores. Won't be more DICOM stores than the
	// value of page_size in the request.
	DicomStores []*DicomStore `json:"dicomStores,omitempty"`
	// NextPageToken: Token to retrieve the next page of results or empty if there
	// are no more results in the list.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "DicomStores") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "DicomStores") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListDicomStoresResponse: Lists the DICOM stores in the given dataset.

func (ListDicomStoresResponse) MarshalJSON

func (s ListDicomStoresResponse) MarshalJSON() ([]byte, error)

type ListFhirStoresResponse

type ListFhirStoresResponse struct {
	// FhirStores: The returned FHIR stores. Won't be more FHIR stores than the
	// value of page_size in the request.
	FhirStores []*FhirStore `json:"fhirStores,omitempty"`
	// NextPageToken: Token to retrieve the next page of results or empty if there
	// are no more results in the list.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "FhirStores") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "FhirStores") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListFhirStoresResponse: Lists the FHIR stores in the given dataset.

func (ListFhirStoresResponse) MarshalJSON

func (s ListFhirStoresResponse) MarshalJSON() ([]byte, error)

type ListHl7V2StoresResponse

type ListHl7V2StoresResponse struct {
	// Hl7V2Stores: The returned HL7v2 stores. Won't be more HL7v2 stores than the
	// value of page_size in the request.
	Hl7V2Stores []*Hl7V2Store `json:"hl7V2Stores,omitempty"`
	// NextPageToken: Token to retrieve the next page of results or empty if there
	// are no more results in the list.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Hl7V2Stores") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Hl7V2Stores") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListHl7V2StoresResponse: Lists the HL7v2 stores in the given dataset.

func (ListHl7V2StoresResponse) MarshalJSON

func (s ListHl7V2StoresResponse) MarshalJSON() ([]byte, error)

type ListLocationsResponse added in v0.32.0

type ListLocationsResponse struct {
	// Locations: A list of locations that matches the specified filter in the
	// request.
	Locations []*Location `json:"locations,omitempty"`
	// NextPageToken: The standard List next-page token.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Locations") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Locations") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListLocationsResponse: The response message for Locations.ListLocations.

func (ListLocationsResponse) MarshalJSON added in v0.32.0

func (s ListLocationsResponse) MarshalJSON() ([]byte, error)

type ListMessagesResponse

type ListMessagesResponse struct {
	// Hl7V2Messages: The returned Messages. Won't be more Messages than the value
	// of page_size in the request. See view for populated fields.
	Hl7V2Messages []*Message `json:"hl7V2Messages,omitempty"`
	// NextPageToken: Token to retrieve the next page of results or empty if there
	// are no more results in the list.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Hl7V2Messages") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Hl7V2Messages") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListMessagesResponse: Lists the messages in the specified HL7v2 store.

func (ListMessagesResponse) MarshalJSON

func (s ListMessagesResponse) MarshalJSON() ([]byte, error)

type ListOperationsResponse

type ListOperationsResponse struct {
	// NextPageToken: The standard List next-page token.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// Operations: A list of operations that matches the specified filter in the
	// request.
	Operations []*Operation `json:"operations,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "NextPageToken") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "NextPageToken") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListOperationsResponse: The response message for Operations.ListOperations.

func (ListOperationsResponse) MarshalJSON

func (s ListOperationsResponse) MarshalJSON() ([]byte, error)

type ListUserDataMappingsResponse added in v0.41.0

type ListUserDataMappingsResponse struct {
	// NextPageToken: Token to retrieve the next page of results, or empty if there
	// are no more results in the list.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// UserDataMappings: The returned User data mappings. The maximum number of
	// User data mappings returned is determined by the value of page_size in the
	// ListUserDataMappingsRequest.
	UserDataMappings []*UserDataMapping `json:"userDataMappings,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "NextPageToken") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "NextPageToken") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

func (ListUserDataMappingsResponse) MarshalJSON added in v0.41.0

func (s ListUserDataMappingsResponse) MarshalJSON() ([]byte, error)

type Location added in v0.32.0

type Location struct {
	// DisplayName: The friendly name for this location, typically a nearby city
	// name. For example, "Tokyo".
	DisplayName string `json:"displayName,omitempty"`
	// Labels: Cross-service attributes for the location. For example
	// {"cloud.googleapis.com/region": "us-east1"}
	Labels map[string]string `json:"labels,omitempty"`
	// LocationId: The canonical id for this location. For example: "us-east1".
	LocationId string `json:"locationId,omitempty"`
	// Metadata: Service-specific metadata. For example the available capacity at
	// the given location.
	Metadata googleapi.RawMessage `json:"metadata,omitempty"`
	// Name: Resource name for the location, which may vary between
	// implementations. For example:
	// "projects/example-project/locations/us-east1"
	Name string `json:"name,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "DisplayName") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "DisplayName") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Location: A resource that represents a Google Cloud location.

func (Location) MarshalJSON added in v0.32.0

func (s Location) MarshalJSON() ([]byte, error)

type Message

type Message struct {
	// CreateTime: Output only. The datetime when the message was created. Set by
	// the server.
	CreateTime string `json:"createTime,omitempty"`
	// Data: Required. Raw message bytes.
	Data string `json:"data,omitempty"`
	// Labels: User-supplied key-value pairs used to organize HL7v2 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.
	Labels map[string]string `json:"labels,omitempty"`
	// MessageType: Output only. The message type for this message. MSH-9.1.
	MessageType string `json:"messageType,omitempty"`
	// Name: Output only. Resource name of the Message, of the form
	// `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Sto
	// res/{hl7_v2_store_id}/messages/{message_id}`.
	Name string `json:"name,omitempty"`
	// ParsedData: Output only. The parsed version of the raw message data.
	ParsedData *ParsedData `json:"parsedData,omitempty"`
	// PatientIds: Output only. All patient IDs listed in the PID-2, PID-3, and
	// PID-4 segments of this message.
	PatientIds []*PatientId `json:"patientIds,omitempty"`
	// SchematizedData: Output only. The parsed version of the raw message data
	// schematized according to this store's schemas and type definitions.
	SchematizedData *SchematizedData `json:"schematizedData,omitempty"`
	// SendFacility: Output only. The hospital that this message came from. MSH-4.
	SendFacility string `json:"sendFacility,omitempty"`
	// SendTime: Output only. The datetime the sending application sent this
	// message. MSH-7.
	SendTime string `json:"sendTime,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "CreateTime") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "CreateTime") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Message: A complete HL7v2 message. See [Introduction to HL7 Standards] (https://www.hl7.org/implement/standards/index.cfm?ref=common) for details on the standard.

func (Message) MarshalJSON

func (s Message) MarshalJSON() ([]byte, error)

type NotificationConfig

type NotificationConfig struct {
	// PubsubTopic: The Pub/Sub (https://cloud.google.com/pubsub/docs/) 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
	// (https://cloud.google.com/pubsub/docs/overview#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
	// (https://cloud.google.com/healthcare/docs/how-tos/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
	// (https://cloud.google.com/healthcare/docs/how-tos/pubsub) for specific
	// details.
	PubsubTopic string `json:"pubsubTopic,omitempty"`
	// SendForBulkImport: Indicates whether or not to send Pub/Sub notifications on
	// bulk import. Only supported for DICOM imports.
	SendForBulkImport bool `json:"sendForBulkImport,omitempty"`
	// ForceSendFields is a list of field names (e.g. "PubsubTopic") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "PubsubTopic") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (NotificationConfig) MarshalJSON

func (s NotificationConfig) MarshalJSON() ([]byte, error)

type Operation

type Operation struct {
	// Done: If the value is `false`, it means the operation is still in progress.
	// If `true`, the operation is completed, and either `error` or `response` is
	// available.
	Done bool `json:"done,omitempty"`
	// Error: The error result of the operation in case of failure or cancellation.
	Error *Status `json:"error,omitempty"`
	// Metadata: Service-specific metadata associated with the operation. It
	// typically contains progress information and common metadata such as create
	// time. Some services might not provide such metadata. Any method that returns
	// a long-running operation should document the metadata type, if any.
	Metadata googleapi.RawMessage `json:"metadata,omitempty"`
	// Name: The server-assigned name, which is only unique within the same service
	// that originally returns it. If you use the default HTTP mapping, the `name`
	// should be a resource name ending with `operations/{unique_id}`.
	Name string `json:"name,omitempty"`
	// Response: The normal, successful response of the operation. If the original
	// method returns no data on success, such as `Delete`, the response is
	// `google.protobuf.Empty`. If the original method is standard
	// `Get`/`Create`/`Update`, the response should be the resource. For other
	// methods, the response should have the type `XxxResponse`, where `Xxx` is the
	// original method name. For example, if the original method name is
	// `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
	Response googleapi.RawMessage `json:"response,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Done") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Done") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Operation: This resource represents a long-running operation that is the result of a network API call.

func (Operation) MarshalJSON

func (s Operation) MarshalJSON() ([]byte, error)

type OperationMetadata

type OperationMetadata struct {
	// ApiMethodName: The name of the API method that initiated the operation.
	ApiMethodName string `json:"apiMethodName,omitempty"`
	// CancelRequested: Specifies if cancellation was requested for the operation.
	CancelRequested bool             `json:"cancelRequested,omitempty"`
	Counter         *ProgressCounter `json:"counter,omitempty"`
	// CreateTime: The time at which the operation was created by the API.
	CreateTime string `json:"createTime,omitempty"`
	// EndTime: The time at which execution was completed.
	EndTime string `json:"endTime,omitempty"`
	// LogsUrl: A link to audit and error logs in the log viewer. Error logs are
	// generated only by some operations, listed at Viewing error logs in Cloud
	// Logging (https://cloud.google.com/healthcare/docs/how-tos/logging).
	LogsUrl string `json:"logsUrl,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ApiMethodName") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ApiMethodName") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

OperationMetadata: OperationMetadata provides information about the operation execution. Returned in the long-running operation's metadata field.

func (OperationMetadata) MarshalJSON

func (s OperationMetadata) MarshalJSON() ([]byte, error)

type ParsedData

type ParsedData struct {
	Segments []*Segment `json:"segments,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Segments") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Segments") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ParsedData: The content of a HL7v2 message in a structured format.

func (ParsedData) MarshalJSON

func (s ParsedData) MarshalJSON() ([]byte, error)

type ParserConfig

type ParserConfig struct {
	// AllowNullHeader: Determines whether messages with no header are allowed.
	AllowNullHeader bool `json:"allowNullHeader,omitempty"`
	// Schema: Schemas used to parse messages in this store, if schematized parsing
	// is desired.
	Schema *SchemaPackage `json:"schema,omitempty"`
	// SegmentTerminator: Byte(s) to use as the segment terminator. If this is
	// unset, '\r' is used as segment terminator, matching the HL7 version 2
	// specification.
	SegmentTerminator string `json:"segmentTerminator,omitempty"`
	// Version: Immutable. Determines the version of both the default parser to be
	// used when `schema` is not given, as well as the schematized parser used when
	// `schema` is specified. This field is immutable after HL7v2 store creation.
	//
	// Possible values:
	//   "PARSER_VERSION_UNSPECIFIED" - Unspecified parser version, equivalent to
	// V1.
	//   "V1" - The `parsed_data` includes every given non-empty message field
	// except the Field Separator (MSH-1) field. As a result, the parsed MSH
	// segment starts with the MSH-2 field and the field numbers are off-by-one
	// with respect to the HL7 standard.
	//   "V2" - The `parsed_data` includes every given non-empty message field.
	//   "V3" - This version is the same as V2, with the following change. The
	// `parsed_data` contains unescaped escaped field separators, component
	// separators, sub-component separators, repetition separators, escape
	// characters, and truncation characters. If `schema` is specified, the
	// schematized parser uses improved parsing heuristics compared to previous
	// versions.
	Version string `json:"version,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AllowNullHeader") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AllowNullHeader") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (ParserConfig) MarshalJSON

func (s ParserConfig) MarshalJSON() ([]byte, error)

type PatientId

type PatientId struct {
	// Type: ID type. For example, MRN or NHS.
	Type string `json:"type,omitempty"`
	// Value: The patient's unique identifier.
	Value string `json:"value,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Type") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Type") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

PatientId: A patient identifier and associated type.

func (PatientId) MarshalJSON

func (s PatientId) MarshalJSON() ([]byte, error)

type Policy

type Policy struct {
	// AuditConfigs: Specifies cloud audit logging configuration for this policy.
	AuditConfigs []*AuditConfig `json:"auditConfigs,omitempty"`
	// Bindings: Associates a list of `members`, or principals, with a `role`.
	// Optionally, may specify a `condition` that determines how and when the
	// `bindings` are applied. Each of the `bindings` must contain at least one
	// principal. The `bindings` in a `Policy` can refer to up to 1,500 principals;
	// up to 250 of these principals can be Google groups. Each occurrence of a
	// principal counts towards these limits. For example, if the `bindings` grant
	// 50 different roles to `user:alice@example.com`, and not to any other
	// principal, then you can add another 1,450 principals to the `bindings` in
	// the `Policy`.
	Bindings []*Binding `json:"bindings,omitempty"`
	// Etag: `etag` is used for optimistic concurrency control as a way to help
	// prevent simultaneous updates of a policy from overwriting each other. It is
	// strongly suggested that systems make use of the `etag` in the
	// read-modify-write cycle to perform policy updates in order to avoid race
	// conditions: An `etag` is returned in the response to `getIamPolicy`, and
	// systems are expected to put that etag in the request to `setIamPolicy` to
	// ensure that their change will be applied to the same version of the policy.
	// **Important:** If you use IAM Conditions, you must include the `etag` field
	// whenever you call `setIamPolicy`. If you omit this field, then IAM allows
	// you to overwrite a version `3` policy with a version `1` policy, and all of
	// the conditions in the version `3` policy are lost.
	Etag string `json:"etag,omitempty"`
	// Version: Specifies the format of the policy. Valid values are `0`, `1`, and
	// `3`. Requests that specify an invalid value are rejected. Any operation that
	// affects conditional role bindings must specify version `3`. This requirement
	// applies to the following operations: * Getting a policy that includes a
	// conditional role binding * Adding a conditional role binding to a policy *
	// Changing a conditional role binding in a policy * Removing any role binding,
	// with or without a condition, from a policy that includes conditions
	// **Important:** If you use IAM Conditions, you must include the `etag` field
	// whenever you call `setIamPolicy`. If you omit this field, then IAM allows
	// you to overwrite a version `3` policy with a version `1` policy, and all of
	// the conditions in the version `3` policy are lost. If a policy does not
	// include any conditions, operations on that policy may specify any valid
	// version or leave the field unset. To learn which resources support
	// conditions in their IAM policies, see the IAM documentation
	// (https://cloud.google.com/iam/help/conditions/resource-policies).
	Version int64 `json:"version,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "AuditConfigs") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AuditConfigs") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Policy: An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).

func (Policy) MarshalJSON

func (s Policy) MarshalJSON() ([]byte, error)

type ProgressCounter

type ProgressCounter struct {
	// Failure: The number of units that failed in the operation.
	Failure int64 `json:"failure,omitempty,string"`
	// Pending: The number of units that are pending in the operation.
	Pending int64 `json:"pending,omitempty,string"`
	// Success: The number of units that succeeded in the operation.
	Success int64 `json:"success,omitempty,string"`
	// ForceSendFields is a list of field names (e.g. "Failure") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Failure") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ProgressCounter: ProgressCounter provides counters to describe an operation's progress.

func (ProgressCounter) MarshalJSON

func (s ProgressCounter) MarshalJSON() ([]byte, error)

type ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsCreateCall added in v0.41.0

type ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsCreateCall) AttributeDefinitionId added in v0.41.0

AttributeDefinitionId sets the optional parameter "attributeDefinitionId": Required. The ID of the Attribute definition to create. The string must match the following regex: `_a-zA-Z{0,255}` and must not be a reserved keyword within the Common Expression Language as listed on https://github.com/google/cel-spec/blob/master/doc/langdef.md.

func (*ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsCreateCall) Context added in v0.41.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsCreateCall) Do added in v0.41.0

Do executes the "healthcare.projects.locations.datasets.consentStores.attributeDefinitions.create" call. Any non-2xx status code is an error. Response headers are in either *AttributeDefinition.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsCreateCall) Fields added in v0.41.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsCreateCall) Header added in v0.41.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsDeleteCall added in v0.41.0

type ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsDeleteCall) Context added in v0.41.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsDeleteCall) Do added in v0.41.0

Do executes the "healthcare.projects.locations.datasets.consentStores.attributeDefinitions.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsDeleteCall) Fields added in v0.41.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsDeleteCall) Header added in v0.41.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsGetCall added in v0.41.0

type ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsGetCall) Context added in v0.41.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsGetCall) Do added in v0.41.0

Do executes the "healthcare.projects.locations.datasets.consentStores.attributeDefinitions.get" call. Any non-2xx status code is an error. Response headers are in either *AttributeDefinition.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsGetCall) Fields added in v0.41.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsGetCall) Header added in v0.41.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsGetCall) IfNoneMatch added in v0.41.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsListCall added in v0.41.0

type ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsListCall) Context added in v0.41.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsListCall) Do added in v0.41.0

Do executes the "healthcare.projects.locations.datasets.consentStores.attributeDefinitions.list" call. Any non-2xx status code is an error. Response headers are in either *ListAttributeDefinitionsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsListCall) Fields added in v0.41.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsListCall) Filter added in v0.41.0

Filter sets the optional parameter "filter": Restricts the attributes returned to those matching a filter. The only field available for filtering is `category`. For example, `filter=category=\"REQUEST\".

func (*ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsListCall) Header added in v0.41.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsListCall) IfNoneMatch added in v0.41.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsListCall) PageSize added in v0.41.0

PageSize sets the optional parameter "pageSize": Limit on the number of Attribute definitions to return in a single response. If not specified, 100 is used. May not be larger than 1000.

func (*ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsListCall) PageToken added in v0.41.0

PageToken sets the optional parameter "pageToken": Token to retrieve the next page of results or empty to get the first page.

func (*ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsListCall) Pages added in v0.41.0

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsPatchCall added in v0.41.0

type ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsPatchCall) Context added in v0.41.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsPatchCall) Do added in v0.41.0

Do executes the "healthcare.projects.locations.datasets.consentStores.attributeDefinitions.patch" call. Any non-2xx status code is an error. Response headers are in either *AttributeDefinition.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsPatchCall) Fields added in v0.41.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsPatchCall) Header added in v0.41.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsPatchCall) UpdateMask added in v0.41.0

UpdateMask sets the optional parameter "updateMask": Required. The update mask that applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask. Only the `description`, `allowed_values`, `consent_default_values` and `data_mapping_default_value` fields can be updated. The updated `allowed_values` must contain all values from the previous `allowed_values`.

type ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsService added in v0.41.0

type ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsService struct {
	// contains filtered or unexported fields
}

func NewProjectsLocationsDatasetsConsentStoresAttributeDefinitionsService added in v0.41.0

func NewProjectsLocationsDatasetsConsentStoresAttributeDefinitionsService(s *Service) *ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsService

func (*ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsService) Create added in v0.41.0

Create: Creates a new Attribute definition in the parent consent store.

  • parent: The name of the consent store that this Attribute definition belongs to.

func (*ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsService) Delete added in v0.41.0

Delete: Deletes the specified Attribute definition. Fails if the Attribute definition is referenced by any User data mapping, or the latest revision of any Consent.

  • name: The resource name of the Attribute definition to delete. To preserve referential integrity, Attribute definitions referenced by a User data mapping or the latest revision of a Consent cannot be deleted.

func (*ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsService) Get added in v0.41.0

Get: Gets the specified Attribute definition.

- name: The resource name of the Attribute definition to get.

func (*ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsService) List added in v0.41.0

List: Lists the Attribute definitions in the specified consent store.

- parent: Name of the consent store to retrieve Attribute definitions from.

func (*ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsService) Patch added in v0.41.0

Patch: Updates the specified Attribute definition.

  • name: Identifier. Resource name of the Attribute definition, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consen tStores/{consent_store_id}/attributeDefinitions/{attribute_definition_id}`. Cannot be changed after creation.

type ProjectsLocationsDatasetsConsentStoresCheckDataAccessCall added in v0.41.0

type ProjectsLocationsDatasetsConsentStoresCheckDataAccessCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresCheckDataAccessCall) Context added in v0.41.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsConsentStoresCheckDataAccessCall) Do added in v0.41.0

Do executes the "healthcare.projects.locations.datasets.consentStores.checkDataAccess" call. Any non-2xx status code is an error. Response headers are in either *CheckDataAccessResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresCheckDataAccessCall) Fields added in v0.41.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsConsentStoresCheckDataAccessCall) Header added in v0.41.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDatasetsConsentStoresConsentArtifactsCreateCall added in v0.41.0

type ProjectsLocationsDatasetsConsentStoresConsentArtifactsCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresConsentArtifactsCreateCall) Context added in v0.41.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsConsentStoresConsentArtifactsCreateCall) Do added in v0.41.0

Do executes the "healthcare.projects.locations.datasets.consentStores.consentArtifacts.create" call. Any non-2xx status code is an error. Response headers are in either *ConsentArtifact.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresConsentArtifactsCreateCall) Fields added in v0.41.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsConsentStoresConsentArtifactsCreateCall) Header added in v0.41.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDatasetsConsentStoresConsentArtifactsDeleteCall added in v0.41.0

type ProjectsLocationsDatasetsConsentStoresConsentArtifactsDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresConsentArtifactsDeleteCall) Context added in v0.41.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsConsentStoresConsentArtifactsDeleteCall) Do added in v0.41.0

Do executes the "healthcare.projects.locations.datasets.consentStores.consentArtifacts.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresConsentArtifactsDeleteCall) Fields added in v0.41.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsConsentStoresConsentArtifactsDeleteCall) Header added in v0.41.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDatasetsConsentStoresConsentArtifactsGetCall added in v0.41.0

type ProjectsLocationsDatasetsConsentStoresConsentArtifactsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresConsentArtifactsGetCall) Context added in v0.41.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsConsentStoresConsentArtifactsGetCall) Do added in v0.41.0

Do executes the "healthcare.projects.locations.datasets.consentStores.consentArtifacts.get" call. Any non-2xx status code is an error. Response headers are in either *ConsentArtifact.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresConsentArtifactsGetCall) Fields added in v0.41.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsConsentStoresConsentArtifactsGetCall) Header added in v0.41.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDatasetsConsentStoresConsentArtifactsGetCall) IfNoneMatch added in v0.41.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsDatasetsConsentStoresConsentArtifactsListCall added in v0.41.0

type ProjectsLocationsDatasetsConsentStoresConsentArtifactsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresConsentArtifactsListCall) Context added in v0.41.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsConsentStoresConsentArtifactsListCall) Do added in v0.41.0

Do executes the "healthcare.projects.locations.datasets.consentStores.consentArtifacts.list" call. Any non-2xx status code is an error. Response headers are in either *ListConsentArtifactsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresConsentArtifactsListCall) Fields added in v0.41.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsConsentStoresConsentArtifactsListCall) Filter added in v0.41.0

Filter sets the optional parameter "filter": Restricts the artifacts returned to those matching a filter. The following syntax is available: * A string field value can be written as text inside quotation marks, for example "query text". The only valid relational operation for text fields is equality (`=`), where text is searched within the field, rather than having the field be equal to the text. For example, "Comment = great" returns messages with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. The fields available for filtering are: - user_id. For example, `filter=user_id=\"user123\". - consent_content_version - metadata. For example, `filter=Metadata(\"testkey\")=\"value\" or `filter=HasMetadata(\"testkey\")`.

func (*ProjectsLocationsDatasetsConsentStoresConsentArtifactsListCall) Header added in v0.41.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDatasetsConsentStoresConsentArtifactsListCall) IfNoneMatch added in v0.41.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsDatasetsConsentStoresConsentArtifactsListCall) PageSize added in v0.41.0

PageSize sets the optional parameter "pageSize": Limit on the number of consent artifacts to return in a single response. If not specified, 100 is used. May not be larger than 1000.

func (*ProjectsLocationsDatasetsConsentStoresConsentArtifactsListCall) PageToken added in v0.41.0

PageToken sets the optional parameter "pageToken": The next_page_token value returned from the previous List request, if any.

func (*ProjectsLocationsDatasetsConsentStoresConsentArtifactsListCall) Pages added in v0.41.0

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsDatasetsConsentStoresConsentArtifactsService added in v0.41.0

type ProjectsLocationsDatasetsConsentStoresConsentArtifactsService struct {
	// contains filtered or unexported fields
}

func NewProjectsLocationsDatasetsConsentStoresConsentArtifactsService added in v0.41.0

func NewProjectsLocationsDatasetsConsentStoresConsentArtifactsService(s *Service) *ProjectsLocationsDatasetsConsentStoresConsentArtifactsService

func (*ProjectsLocationsDatasetsConsentStoresConsentArtifactsService) Create added in v0.41.0

Create: Creates a new Consent artifact in the parent consent store.

- parent: The name of the consent store this Consent artifact belongs to.

func (*ProjectsLocationsDatasetsConsentStoresConsentArtifactsService) Delete added in v0.41.0

Delete: Deletes the specified Consent artifact. Fails if the artifact is referenced by the latest revision of any Consent.

  • name: The resource name of the Consent artifact to delete. To preserve referential integrity, Consent artifacts referenced by the latest revision of a Consent cannot be deleted.

func (*ProjectsLocationsDatasetsConsentStoresConsentArtifactsService) Get added in v0.41.0

Get: Gets the specified Consent artifact.

- name: The resource name of the Consent artifact to retrieve.

func (*ProjectsLocationsDatasetsConsentStoresConsentArtifactsService) List added in v0.41.0

List: Lists the Consent artifacts in the specified consent store.

- parent: Name of the consent store to retrieve consent artifacts from.

type ProjectsLocationsDatasetsConsentStoresConsentsActivateCall added in v0.41.0

type ProjectsLocationsDatasetsConsentStoresConsentsActivateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresConsentsActivateCall) Context added in v0.41.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsConsentStoresConsentsActivateCall) Do added in v0.41.0

Do executes the "healthcare.projects.locations.datasets.consentStores.consents.activate" call. Any non-2xx status code is an error. Response headers are in either *Consent.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresConsentsActivateCall) Fields added in v0.41.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsConsentStoresConsentsActivateCall) Header added in v0.41.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDatasetsConsentStoresConsentsCreateCall added in v0.41.0

type ProjectsLocationsDatasetsConsentStoresConsentsCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresConsentsCreateCall) Context added in v0.41.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsConsentStoresConsentsCreateCall) Do added in v0.41.0

Do executes the "healthcare.projects.locations.datasets.consentStores.consents.create" call. Any non-2xx status code is an error. Response headers are in either *Consent.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresConsentsCreateCall) Fields added in v0.41.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsConsentStoresConsentsCreateCall) Header added in v0.41.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDatasetsConsentStoresConsentsDeleteCall added in v0.41.0

type ProjectsLocationsDatasetsConsentStoresConsentsDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresConsentsDeleteCall) Context added in v0.41.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsConsentStoresConsentsDeleteCall) Do added in v0.41.0

Do executes the "healthcare.projects.locations.datasets.consentStores.consents.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresConsentsDeleteCall) Fields added in v0.41.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsConsentStoresConsentsDeleteCall) Header added in v0.41.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDatasetsConsentStoresConsentsDeleteRevisionCall added in v0.41.0

type ProjectsLocationsDatasetsConsentStoresConsentsDeleteRevisionCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresConsentsDeleteRevisionCall) Context added in v0.41.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsConsentStoresConsentsDeleteRevisionCall) Do added in v0.41.0

Do executes the "healthcare.projects.locations.datasets.consentStores.consents.deleteRevision" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresConsentsDeleteRevisionCall) Fields added in v0.41.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsConsentStoresConsentsDeleteRevisionCall) Header added in v0.41.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDatasetsConsentStoresConsentsGetCall added in v0.41.0

type ProjectsLocationsDatasetsConsentStoresConsentsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresConsentsGetCall) Context added in v0.41.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsConsentStoresConsentsGetCall) Do added in v0.41.0

Do executes the "healthcare.projects.locations.datasets.consentStores.consents.get" call. Any non-2xx status code is an error. Response headers are in either *Consent.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresConsentsGetCall) Fields added in v0.41.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsConsentStoresConsentsGetCall) Header added in v0.41.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDatasetsConsentStoresConsentsGetCall) IfNoneMatch added in v0.41.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsDatasetsConsentStoresConsentsListCall added in v0.41.0

type ProjectsLocationsDatasetsConsentStoresConsentsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresConsentsListCall) Context added in v0.41.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsConsentStoresConsentsListCall) Do added in v0.41.0

Do executes the "healthcare.projects.locations.datasets.consentStores.consents.list" call. Any non-2xx status code is an error. Response headers are in either *ListConsentsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresConsentsListCall) Fields added in v0.41.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsConsentStoresConsentsListCall) Filter added in v0.41.0

Filter sets the optional parameter "filter": Restricts the Consents returned to those matching a filter. The following syntax is available: * A string field value can be written as text inside quotation marks, for example "query text". The only valid relational operation for text fields is equality (`=`), where text is searched within the field, rather than having the field be equal to the text. For example, "Comment = great" returns messages with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. The fields available for filtering are: - user_id. For example, `filter='user_id="user123"'`. - consent_artifact - state - revision_create_time - metadata. For example, `filter=Metadata(\"testkey\")=\"value\" or `filter=HasMetadata(\"testkey\")`.

func (*ProjectsLocationsDatasetsConsentStoresConsentsListCall) Header added in v0.41.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDatasetsConsentStoresConsentsListCall) IfNoneMatch added in v0.41.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsDatasetsConsentStoresConsentsListCall) PageSize added in v0.41.0

PageSize sets the optional parameter "pageSize": Limit on the number of Consents to return in a single response. If not specified, 100 is used. May not be larger than 1000.

func (*ProjectsLocationsDatasetsConsentStoresConsentsListCall) PageToken added in v0.41.0

PageToken sets the optional parameter "pageToken": The next_page_token value returned from the previous List request, if any.

func (*ProjectsLocationsDatasetsConsentStoresConsentsListCall) Pages added in v0.41.0

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsDatasetsConsentStoresConsentsListRevisionsCall added in v0.41.0

type ProjectsLocationsDatasetsConsentStoresConsentsListRevisionsCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresConsentsListRevisionsCall) Context added in v0.41.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsConsentStoresConsentsListRevisionsCall) Do added in v0.41.0

Do executes the "healthcare.projects.locations.datasets.consentStores.consents.listRevisions" call. Any non-2xx status code is an error. Response headers are in either *ListConsentRevisionsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresConsentsListRevisionsCall) Fields added in v0.41.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsConsentStoresConsentsListRevisionsCall) Filter added in v0.41.0

Filter sets the optional parameter "filter": Restricts the revisions returned to those matching a filter. The following syntax is available: * A string field value can be written as text inside quotation marks, for example "query text". The only valid relational operation for text fields is equality (`=`), where text is searched within the field, rather than having the field be equal to the text. For example, "Comment = great" returns messages with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. Fields available for filtering are: - user_id. For example, `filter='user_id="user123"'`. - consent_artifact - state - revision_create_time - metadata. For example, `filter=Metadata(\"testkey\")=\"value\" or `filter=HasMetadata(\"testkey\")`.

func (*ProjectsLocationsDatasetsConsentStoresConsentsListRevisionsCall) Header added in v0.41.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDatasetsConsentStoresConsentsListRevisionsCall) IfNoneMatch added in v0.41.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsDatasetsConsentStoresConsentsListRevisionsCall) PageSize added in v0.41.0

PageSize sets the optional parameter "pageSize": Limit on the number of revisions to return in a single response. If not specified, 100 is used. May not be larger than 1000.

func (*ProjectsLocationsDatasetsConsentStoresConsentsListRevisionsCall) PageToken added in v0.41.0

PageToken sets the optional parameter "pageToken": Token to retrieve the next page of results or empty if there are no more results in the list.

func (*ProjectsLocationsDatasetsConsentStoresConsentsListRevisionsCall) Pages added in v0.41.0

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsDatasetsConsentStoresConsentsPatchCall added in v0.41.0

type ProjectsLocationsDatasetsConsentStoresConsentsPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresConsentsPatchCall) Context added in v0.41.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsConsentStoresConsentsPatchCall) Do added in v0.41.0

Do executes the "healthcare.projects.locations.datasets.consentStores.consents.patch" call. Any non-2xx status code is an error. Response headers are in either *Consent.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresConsentsPatchCall) Fields added in v0.41.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsConsentStoresConsentsPatchCall) Header added in v0.41.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDatasetsConsentStoresConsentsPatchCall) UpdateMask added in v0.41.0

UpdateMask sets the optional parameter "updateMask": Required. The update mask to apply to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask. Only the `user_id`, `policies`, `consent_artifact`, and `metadata` fields can be updated.

type ProjectsLocationsDatasetsConsentStoresConsentsRejectCall added in v0.41.0

type ProjectsLocationsDatasetsConsentStoresConsentsRejectCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresConsentsRejectCall) Context added in v0.41.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsConsentStoresConsentsRejectCall) Do added in v0.41.0

Do executes the "healthcare.projects.locations.datasets.consentStores.consents.reject" call. Any non-2xx status code is an error. Response headers are in either *Consent.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresConsentsRejectCall) Fields added in v0.41.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsConsentStoresConsentsRejectCall) Header added in v0.41.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDatasetsConsentStoresConsentsRevokeCall added in v0.41.0

type ProjectsLocationsDatasetsConsentStoresConsentsRevokeCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresConsentsRevokeCall) Context added in v0.41.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsConsentStoresConsentsRevokeCall) Do added in v0.41.0

Do executes the "healthcare.projects.locations.datasets.consentStores.consents.revoke" call. Any non-2xx status code is an error. Response headers are in either *Consent.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresConsentsRevokeCall) Fields added in v0.41.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsConsentStoresConsentsRevokeCall) Header added in v0.41.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDatasetsConsentStoresConsentsService added in v0.41.0

type ProjectsLocationsDatasetsConsentStoresConsentsService struct {
	// contains filtered or unexported fields
}

func NewProjectsLocationsDatasetsConsentStoresConsentsService added in v0.41.0

func NewProjectsLocationsDatasetsConsentStoresConsentsService(s *Service) *ProjectsLocationsDatasetsConsentStoresConsentsService

func (*ProjectsLocationsDatasetsConsentStoresConsentsService) Activate added in v0.41.0

Activate: Activates the latest revision of the specified Consent by committing a new revision with `state` updated to `ACTIVE`. If the latest revision of the specified Consent is in the `ACTIVE` state, no new revision is committed. A FAILED_PRECONDITION error occurs if the latest revision of the specified Consent is in the `REJECTED` or `REVOKED` state.

  • name: The resource name of the Consent to activate, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consen tStores/{consent_store_id}/consents/{consent_id}`. An INVALID_ARGUMENT error occurs if `revision_id` is specified in the name.

func (*ProjectsLocationsDatasetsConsentStoresConsentsService) Create added in v0.41.0

Create: Creates a new Consent in the parent consent store.

- parent: Name of the consent store.

func (*ProjectsLocationsDatasetsConsentStoresConsentsService) Delete added in v0.41.0

Delete: Deletes the Consent and its revisions. To keep a record of the Consent but mark it inactive, see [RevokeConsent]. To delete a revision of a Consent, see [DeleteConsentRevision]. This operation does not delete the related Consent artifact.

  • name: The resource name of the Consent to delete, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consen tStores/{consent_store_id}/consents/{consent_id}`. An INVALID_ARGUMENT error occurs if `revision_id` is specified in the name.

func (*ProjectsLocationsDatasetsConsentStoresConsentsService) DeleteRevision added in v0.41.0

DeleteRevision: Deletes the specified revision of a Consent. An INVALID_ARGUMENT error occurs if the specified revision is the latest revision.

  • name: The resource name of the Consent revision to delete, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consen tStores/{consent_store_id}/consents/{consent_id}@{revision_id}`. An INVALID_ARGUMENT error occurs if `revision_id` is not specified in the name.

func (*ProjectsLocationsDatasetsConsentStoresConsentsService) Get added in v0.41.0

Get: Gets the specified revision of a Consent, or the latest revision if `revision_id` is not specified in the resource name.

  • name: The resource name of the Consent to retrieve, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consen tStores/{consent_store_id}/consents/{consent_id}`. In order to retrieve a previous revision of the Consent, also provide the revision ID: `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consen tStores/{consent_store_id}/consents/{consent_id}@{revision_id}`.

func (*ProjectsLocationsDatasetsConsentStoresConsentsService) List added in v0.41.0

List: Lists the Consent in the given consent store, returning each Consent's latest revision.

- parent: Name of the consent store to retrieve Consents from.

func (*ProjectsLocationsDatasetsConsentStoresConsentsService) ListRevisions added in v0.41.0

ListRevisions: Lists the revisions of the specified Consent in reverse chronological order.

- name: The resource name of the Consent to retrieve revisions for.

func (*ProjectsLocationsDatasetsConsentStoresConsentsService) Patch added in v0.41.0

Patch: Updates the latest revision of the specified Consent by committing a new revision with the changes. A FAILED_PRECONDITION error occurs if the latest revision of the specified Consent is in the `REJECTED` or `REVOKED` state.

  • name: Identifier. Resource name of the Consent, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consen tStores/{consent_store_id}/consents/{consent_id}`. Cannot be changed after creation.

func (*ProjectsLocationsDatasetsConsentStoresConsentsService) Reject added in v0.41.0

Reject: Rejects the latest revision of the specified Consent by committing a new revision with `state` updated to `REJECTED`. If the latest revision of the specified Consent is in the `REJECTED` state, no new revision is committed. A FAILED_PRECONDITION error occurs if the latest revision of the specified Consent is in the `ACTIVE` or `REVOKED` state.

  • name: The resource name of the Consent to reject, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consen tStores/{consent_store_id}/consents/{consent_id}`. An INVALID_ARGUMENT error occurs if `revision_id` is specified in the name.

func (*ProjectsLocationsDatasetsConsentStoresConsentsService) Revoke added in v0.41.0

Revoke: Revokes the latest revision of the specified Consent by committing a new revision with `state` updated to `REVOKED`. If the latest revision of the specified Consent is in the `REVOKED` state, no new revision is committed. A FAILED_PRECONDITION error occurs if the latest revision of the given consent is in `DRAFT` or `REJECTED` state.

  • name: The resource name of the Consent to revoke, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consen tStores/{consent_store_id}/consents/{consent_id}`. An INVALID_ARGUMENT error occurs if `revision_id` is specified in the name.

type ProjectsLocationsDatasetsConsentStoresCreateCall added in v0.41.0

type ProjectsLocationsDatasetsConsentStoresCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresCreateCall) ConsentStoreId added in v0.41.0

ConsentStoreId sets the optional parameter "consentStoreId": Required. The ID of the consent store to create. The string must match the following regex: `[\p{L}\p{N}_\-\.]{1,256}`. Cannot be changed after creation.

func (*ProjectsLocationsDatasetsConsentStoresCreateCall) Context added in v0.41.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsConsentStoresCreateCall) Do added in v0.41.0

Do executes the "healthcare.projects.locations.datasets.consentStores.create" call. Any non-2xx status code is an error. Response headers are in either *ConsentStore.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresCreateCall) Fields added in v0.41.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsConsentStoresCreateCall) Header added in v0.41.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDatasetsConsentStoresDeleteCall added in v0.41.0

type ProjectsLocationsDatasetsConsentStoresDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresDeleteCall) Context added in v0.41.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsConsentStoresDeleteCall) Do added in v0.41.0

Do executes the "healthcare.projects.locations.datasets.consentStores.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresDeleteCall) Fields added in v0.41.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsConsentStoresDeleteCall) Header added in v0.41.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDatasetsConsentStoresEvaluateUserConsentsCall added in v0.41.0

type ProjectsLocationsDatasetsConsentStoresEvaluateUserConsentsCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresEvaluateUserConsentsCall) Context added in v0.41.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsConsentStoresEvaluateUserConsentsCall) Do added in v0.41.0

Do executes the "healthcare.projects.locations.datasets.consentStores.evaluateUserConsents" call. Any non-2xx status code is an error. Response headers are in either *EvaluateUserConsentsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresEvaluateUserConsentsCall) Fields added in v0.41.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsConsentStoresEvaluateUserConsentsCall) Header added in v0.41.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDatasetsConsentStoresEvaluateUserConsentsCall) Pages added in v0.41.0

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsDatasetsConsentStoresGetCall added in v0.41.0

type ProjectsLocationsDatasetsConsentStoresGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresGetCall) Context added in v0.41.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsConsentStoresGetCall) Do added in v0.41.0

Do executes the "healthcare.projects.locations.datasets.consentStores.get" call. Any non-2xx status code is an error. Response headers are in either *ConsentStore.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresGetCall) Fields added in v0.41.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsConsentStoresGetCall) Header added in v0.41.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDatasetsConsentStoresGetCall) IfNoneMatch added in v0.41.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsDatasetsConsentStoresGetIamPolicyCall added in v0.38.0

type ProjectsLocationsDatasetsConsentStoresGetIamPolicyCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresGetIamPolicyCall) Context added in v0.38.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsConsentStoresGetIamPolicyCall) Do added in v0.38.0

Do executes the "healthcare.projects.locations.datasets.consentStores.getIamPolicy" call. Any non-2xx status code is an error. Response headers are in either *Policy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresGetIamPolicyCall) Fields added in v0.38.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsConsentStoresGetIamPolicyCall) Header added in v0.38.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDatasetsConsentStoresGetIamPolicyCall) IfNoneMatch added in v0.38.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsDatasetsConsentStoresGetIamPolicyCall) OptionsRequestedPolicyVersion added in v0.38.0

func (c *ProjectsLocationsDatasetsConsentStoresGetIamPolicyCall) OptionsRequestedPolicyVersion(optionsRequestedPolicyVersion int64) *ProjectsLocationsDatasetsConsentStoresGetIamPolicyCall

OptionsRequestedPolicyVersion sets the optional parameter "options.requestedPolicyVersion": The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).

type ProjectsLocationsDatasetsConsentStoresListCall added in v0.41.0

type ProjectsLocationsDatasetsConsentStoresListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresListCall) Context added in v0.41.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsConsentStoresListCall) Do added in v0.41.0

Do executes the "healthcare.projects.locations.datasets.consentStores.list" call. Any non-2xx status code is an error. Response headers are in either *ListConsentStoresResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresListCall) Fields added in v0.41.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsConsentStoresListCall) Filter added in v0.41.0

Filter sets the optional parameter "filter": Restricts the stores returned to those matching a filter. Only filtering on labels is supported. For example, `filter=labels.key=value`.

func (*ProjectsLocationsDatasetsConsentStoresListCall) Header added in v0.41.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDatasetsConsentStoresListCall) IfNoneMatch added in v0.41.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsDatasetsConsentStoresListCall) PageSize added in v0.41.0

PageSize sets the optional parameter "pageSize": Limit on the number of consent stores to return in a single response. If not specified, 100 is used. May not be larger than 1000.

func (*ProjectsLocationsDatasetsConsentStoresListCall) PageToken added in v0.41.0

PageToken sets the optional parameter "pageToken": Token to retrieve the next page of results, or empty to get the first page.

func (*ProjectsLocationsDatasetsConsentStoresListCall) Pages added in v0.41.0

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsDatasetsConsentStoresPatchCall added in v0.41.0

type ProjectsLocationsDatasetsConsentStoresPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresPatchCall) Context added in v0.41.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsConsentStoresPatchCall) Do added in v0.41.0

Do executes the "healthcare.projects.locations.datasets.consentStores.patch" call. Any non-2xx status code is an error. Response headers are in either *ConsentStore.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresPatchCall) Fields added in v0.41.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsConsentStoresPatchCall) Header added in v0.41.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDatasetsConsentStoresPatchCall) UpdateMask added in v0.41.0

UpdateMask sets the optional parameter "updateMask": Required. The update mask that applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask. Only the `labels`, `default_consent_ttl`, and `enable_consent_create_on_update` fields are allowed to be updated.

type ProjectsLocationsDatasetsConsentStoresQueryAccessibleDataCall added in v0.41.0

type ProjectsLocationsDatasetsConsentStoresQueryAccessibleDataCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresQueryAccessibleDataCall) Context added in v0.41.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsConsentStoresQueryAccessibleDataCall) Do added in v0.41.0

Do executes the "healthcare.projects.locations.datasets.consentStores.queryAccessibleData" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresQueryAccessibleDataCall) Fields added in v0.41.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsConsentStoresQueryAccessibleDataCall) Header added in v0.41.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDatasetsConsentStoresService added in v0.38.0

type ProjectsLocationsDatasetsConsentStoresService struct {
	AttributeDefinitions *ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsService

	ConsentArtifacts *ProjectsLocationsDatasetsConsentStoresConsentArtifactsService

	Consents *ProjectsLocationsDatasetsConsentStoresConsentsService

	UserDataMappings *ProjectsLocationsDatasetsConsentStoresUserDataMappingsService
	// contains filtered or unexported fields
}

func NewProjectsLocationsDatasetsConsentStoresService added in v0.38.0

func NewProjectsLocationsDatasetsConsentStoresService(s *Service) *ProjectsLocationsDatasetsConsentStoresService

func (*ProjectsLocationsDatasetsConsentStoresService) CheckDataAccess added in v0.41.0

CheckDataAccess: Checks if a particular data_id of a User data mapping in the specified consent store is consented for the specified use.

  • consentStore: Name of the consent store where the requested data_id is stored, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consen tStores/{consent_store_id}`.

func (*ProjectsLocationsDatasetsConsentStoresService) Create added in v0.41.0

Create: Creates a new consent store in the parent dataset. Attempting to create a consent store with the same ID as an existing store fails with an ALREADY_EXISTS error.

- parent: The name of the dataset this consent store belongs to.

func (*ProjectsLocationsDatasetsConsentStoresService) Delete added in v0.41.0

Delete: Deletes the specified consent store and removes all the consent store's data.

- name: The resource name of the consent store to delete.

func (*ProjectsLocationsDatasetsConsentStoresService) EvaluateUserConsents added in v0.41.0

EvaluateUserConsents: Evaluates the user's Consents for all matching User data mappings. Note: User data mappings are indexed asynchronously, which can cause a slight delay between the time mappings are created or updated and when they are included in EvaluateUserConsents results.

  • consentStore: Name of the consent store to retrieve User data mappings from.

func (*ProjectsLocationsDatasetsConsentStoresService) Get added in v0.41.0

Get: Gets the specified consent store.

- name: The resource name of the consent store to get.

func (*ProjectsLocationsDatasetsConsentStoresService) GetIamPolicy added in v0.38.0

GetIamPolicy: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

func (*ProjectsLocationsDatasetsConsentStoresService) List added in v0.41.0

List: Lists the consent stores in the specified dataset.

- parent: Name of the dataset.

func (*ProjectsLocationsDatasetsConsentStoresService) Patch added in v0.41.0

Patch: Updates the specified consent store.

  • name: Identifier. Resource name of the consent store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consen tStores/{consent_store_id}`. Cannot be changed after creation.

func (*ProjectsLocationsDatasetsConsentStoresService) QueryAccessibleData added in v0.41.0

QueryAccessibleData: Queries all data_ids that are consented for a specified use in the given consent store and writes them to a specified destination. The returned Operation includes a progress counter for the number of User data mappings processed. If the request is successful, a detailed response is returned of type QueryAccessibleDataResponse, contained in the response field when the operation finishes. The metadata field type is OperationMetadata. Errors are logged to Cloud Logging (see Viewing error logs in Cloud Logging (https://cloud.google.com/healthcare/docs/how-tos/logging)). For example, the following sample log entry shows a `failed to evaluate consent policy` error that occurred during a QueryAccessibleData call to consent store `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentS tores/{consent_store_id}`. ```json jsonPayload: { @type: "type.googleapis.com/google.cloud.healthcare.logging.QueryAccessibleDataLogEn try" error: { code: 9 message: "failed to evaluate consent policy" } resourceName: "projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentS tores/{consent_store_id}/consents/{consent_id}" } logName: "projects/{project_id}/logs/healthcare.googleapis.com%2Fquery_accessible_data " operation: { id: "projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/operatio ns/{operation_id}" producer: "healthcare.googleapis.com/QueryAccessibleData" } receiveTimestamp: "TIMESTAMP" resource: { labels: { consent_store_id: "{consent_store_id}" dataset_id: "{dataset_id}" location: "{location_id}" project_id: "{project_id}" } type: "healthcare_consent_store" } severity: "ERROR" timestamp: "TIMESTAMP" ```

  • consentStore: Name of the consent store to retrieve User data mappings from.

func (*ProjectsLocationsDatasetsConsentStoresService) SetIamPolicy added in v0.38.0

SetIamPolicy: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

func (*ProjectsLocationsDatasetsConsentStoresService) TestIamPermissions added in v0.38.0

TestIamPermissions: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

type ProjectsLocationsDatasetsConsentStoresSetIamPolicyCall added in v0.38.0

type ProjectsLocationsDatasetsConsentStoresSetIamPolicyCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresSetIamPolicyCall) Context added in v0.38.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsConsentStoresSetIamPolicyCall) Do added in v0.38.0

Do executes the "healthcare.projects.locations.datasets.consentStores.setIamPolicy" call. Any non-2xx status code is an error. Response headers are in either *Policy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresSetIamPolicyCall) Fields added in v0.38.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsConsentStoresSetIamPolicyCall) Header added in v0.38.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDatasetsConsentStoresTestIamPermissionsCall added in v0.38.0

type ProjectsLocationsDatasetsConsentStoresTestIamPermissionsCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresTestIamPermissionsCall) Context added in v0.38.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsConsentStoresTestIamPermissionsCall) Do added in v0.38.0

Do executes the "healthcare.projects.locations.datasets.consentStores.testIamPermissions" call. Any non-2xx status code is an error. Response headers are in either *TestIamPermissionsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresTestIamPermissionsCall) Fields added in v0.38.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsConsentStoresTestIamPermissionsCall) Header added in v0.38.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDatasetsConsentStoresUserDataMappingsArchiveCall added in v0.41.0

type ProjectsLocationsDatasetsConsentStoresUserDataMappingsArchiveCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsArchiveCall) Context added in v0.41.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsArchiveCall) Do added in v0.41.0

Do executes the "healthcare.projects.locations.datasets.consentStores.userDataMappings.archive" call. Any non-2xx status code is an error. Response headers are in either *ArchiveUserDataMappingResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsArchiveCall) Fields added in v0.41.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsArchiveCall) Header added in v0.41.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDatasetsConsentStoresUserDataMappingsCreateCall added in v0.41.0

type ProjectsLocationsDatasetsConsentStoresUserDataMappingsCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsCreateCall) Context added in v0.41.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsCreateCall) Do added in v0.41.0

Do executes the "healthcare.projects.locations.datasets.consentStores.userDataMappings.create" call. Any non-2xx status code is an error. Response headers are in either *UserDataMapping.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsCreateCall) Fields added in v0.41.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsCreateCall) Header added in v0.41.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDatasetsConsentStoresUserDataMappingsDeleteCall added in v0.41.0

type ProjectsLocationsDatasetsConsentStoresUserDataMappingsDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsDeleteCall) Context added in v0.41.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsDeleteCall) Do added in v0.41.0

Do executes the "healthcare.projects.locations.datasets.consentStores.userDataMappings.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsDeleteCall) Fields added in v0.41.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsDeleteCall) Header added in v0.41.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDatasetsConsentStoresUserDataMappingsGetCall added in v0.41.0

type ProjectsLocationsDatasetsConsentStoresUserDataMappingsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsGetCall) Context added in v0.41.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsGetCall) Do added in v0.41.0

Do executes the "healthcare.projects.locations.datasets.consentStores.userDataMappings.get" call. Any non-2xx status code is an error. Response headers are in either *UserDataMapping.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsGetCall) Fields added in v0.41.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsGetCall) Header added in v0.41.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsGetCall) IfNoneMatch added in v0.41.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsDatasetsConsentStoresUserDataMappingsListCall added in v0.41.0

type ProjectsLocationsDatasetsConsentStoresUserDataMappingsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsListCall) Context added in v0.41.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsListCall) Do added in v0.41.0

Do executes the "healthcare.projects.locations.datasets.consentStores.userDataMappings.list" call. Any non-2xx status code is an error. Response headers are in either *ListUserDataMappingsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsListCall) Fields added in v0.41.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsListCall) Filter added in v0.41.0

Filter sets the optional parameter "filter": Restricts the User data mappings returned to those matching a filter. The following syntax is available: * A string field value can be written as text inside quotation marks, for example "query text". The only valid relational operation for text fields is equality (`=`), where text is searched within the field, rather than having the field be equal to the text. For example, "Comment = great" returns messages with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. The fields available for filtering are: - data_id - user_id. For example, `filter=user_id=\"user123\". - archived - archive_time

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsListCall) Header added in v0.41.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsListCall) IfNoneMatch added in v0.41.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsListCall) PageSize added in v0.41.0

PageSize sets the optional parameter "pageSize": Limit on the number of User data mappings to return in a single response. If not specified, 100 is used. May not be larger than 1000.

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsListCall) PageToken added in v0.41.0

PageToken sets the optional parameter "pageToken": Token to retrieve the next page of results, or empty to get the first page.

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsListCall) Pages added in v0.41.0

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsDatasetsConsentStoresUserDataMappingsPatchCall added in v0.41.0

type ProjectsLocationsDatasetsConsentStoresUserDataMappingsPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsPatchCall) Context added in v0.41.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsPatchCall) Do added in v0.41.0

Do executes the "healthcare.projects.locations.datasets.consentStores.userDataMappings.patch" call. Any non-2xx status code is an error. Response headers are in either *UserDataMapping.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsPatchCall) Fields added in v0.41.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsPatchCall) Header added in v0.41.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsPatchCall) UpdateMask added in v0.41.0

UpdateMask sets the optional parameter "updateMask": Required. The update mask that applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask. Only the `data_id`, `user_id` and `resource_attributes` fields can be updated.

type ProjectsLocationsDatasetsConsentStoresUserDataMappingsService added in v0.41.0

type ProjectsLocationsDatasetsConsentStoresUserDataMappingsService struct {
	// contains filtered or unexported fields
}

func NewProjectsLocationsDatasetsConsentStoresUserDataMappingsService added in v0.41.0

func NewProjectsLocationsDatasetsConsentStoresUserDataMappingsService(s *Service) *ProjectsLocationsDatasetsConsentStoresUserDataMappingsService

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsService) Archive added in v0.41.0

Archive: Archives the specified User data mapping.

- name: The resource name of the User data mapping to archive.

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsService) Create added in v0.41.0

Create: Creates a new User data mapping in the parent consent store.

- parent: Name of the consent store.

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsService) Delete added in v0.41.0

Delete: Deletes the specified User data mapping.

- name: The resource name of the User data mapping to delete.

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsService) Get added in v0.41.0

Get: Gets the specified User data mapping.

- name: The resource name of the User data mapping to retrieve.

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsService) List added in v0.41.0

List: Lists the User data mappings in the specified consent store.

- parent: Name of the consent store to retrieve User data mappings from.

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsService) Patch added in v0.41.0

Patch: Updates the specified User data mapping.

  • name: Resource name of the User data mapping, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consen tStores/{consent_store_id}/userDataMappings/{user_data_mapping_id}`.

type ProjectsLocationsDatasetsCreateCall

type ProjectsLocationsDatasetsCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsCreateCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsCreateCall) DatasetId

DatasetId sets the optional parameter "datasetId": Required. The ID of the dataset that is being created. The string must match the following regex: `[\p{L}\p{N}_\-\.]{1,256}`.

func (*ProjectsLocationsDatasetsCreateCall) Do

Do executes the "healthcare.projects.locations.datasets.create" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsCreateCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDatasetsDataMapperWorkspacesGetIamPolicyCall added in v0.168.0

type ProjectsLocationsDatasetsDataMapperWorkspacesGetIamPolicyCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDataMapperWorkspacesGetIamPolicyCall) Context added in v0.168.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsDataMapperWorkspacesGetIamPolicyCall) Do added in v0.168.0

Do executes the "healthcare.projects.locations.datasets.dataMapperWorkspaces.getIamPolicy" call. Any non-2xx status code is an error. Response headers are in either *Policy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsDataMapperWorkspacesGetIamPolicyCall) Fields added in v0.168.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsDataMapperWorkspacesGetIamPolicyCall) Header added in v0.168.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDatasetsDataMapperWorkspacesGetIamPolicyCall) IfNoneMatch added in v0.168.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsDatasetsDataMapperWorkspacesGetIamPolicyCall) OptionsRequestedPolicyVersion added in v0.168.0

OptionsRequestedPolicyVersion sets the optional parameter "options.requestedPolicyVersion": The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).

type ProjectsLocationsDatasetsDataMapperWorkspacesService added in v0.168.0

type ProjectsLocationsDatasetsDataMapperWorkspacesService struct {
	// contains filtered or unexported fields
}

func NewProjectsLocationsDatasetsDataMapperWorkspacesService added in v0.168.0

func NewProjectsLocationsDatasetsDataMapperWorkspacesService(s *Service) *ProjectsLocationsDatasetsDataMapperWorkspacesService

func (*ProjectsLocationsDatasetsDataMapperWorkspacesService) GetIamPolicy added in v0.168.0

GetIamPolicy: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

func (*ProjectsLocationsDatasetsDataMapperWorkspacesService) SetIamPolicy added in v0.168.0

SetIamPolicy: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

func (*ProjectsLocationsDatasetsDataMapperWorkspacesService) TestIamPermissions added in v0.168.0

TestIamPermissions: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

type ProjectsLocationsDatasetsDataMapperWorkspacesSetIamPolicyCall added in v0.168.0

type ProjectsLocationsDatasetsDataMapperWorkspacesSetIamPolicyCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDataMapperWorkspacesSetIamPolicyCall) Context added in v0.168.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsDataMapperWorkspacesSetIamPolicyCall) Do added in v0.168.0

Do executes the "healthcare.projects.locations.datasets.dataMapperWorkspaces.setIamPolicy" call. Any non-2xx status code is an error. Response headers are in either *Policy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsDataMapperWorkspacesSetIamPolicyCall) Fields added in v0.168.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsDataMapperWorkspacesSetIamPolicyCall) Header added in v0.168.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDatasetsDataMapperWorkspacesTestIamPermissionsCall added in v0.168.0

type ProjectsLocationsDatasetsDataMapperWorkspacesTestIamPermissionsCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDataMapperWorkspacesTestIamPermissionsCall) Context added in v0.168.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsDataMapperWorkspacesTestIamPermissionsCall) Do added in v0.168.0

Do executes the "healthcare.projects.locations.datasets.dataMapperWorkspaces.testIamPermissions" call. Any non-2xx status code is an error. Response headers are in either *TestIamPermissionsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsDataMapperWorkspacesTestIamPermissionsCall) Fields added in v0.168.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsDataMapperWorkspacesTestIamPermissionsCall) Header added in v0.168.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDatasetsDeidentifyCall

type ProjectsLocationsDatasetsDeidentifyCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDeidentifyCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsDeidentifyCall) Do

Do executes the "healthcare.projects.locations.datasets.deidentify" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsDeidentifyCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsDeidentifyCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDatasetsDeleteCall

type ProjectsLocationsDatasetsDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDeleteCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsDeleteCall) Do

Do executes the "healthcare.projects.locations.datasets.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsDeleteCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDatasetsDicomStoresCreateCall

type ProjectsLocationsDatasetsDicomStoresCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresCreateCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsDicomStoresCreateCall) DicomStoreId

DicomStoreId sets the optional parameter "dicomStoreId": Required. The ID of the DICOM store that is being created. Any string value up to 256 characters in length.

func (*ProjectsLocationsDatasetsDicomStoresCreateCall) Do

Do executes the "healthcare.projects.locations.datasets.dicomStores.create" call. Any non-2xx status code is an error. Response headers are in either *DicomStore.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsDicomStoresCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsDicomStoresCreateCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDatasetsDicomStoresDeidentifyCall

type ProjectsLocationsDatasetsDicomStoresDeidentifyCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresDeidentifyCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsDicomStoresDeidentifyCall) Do

Do executes the "healthcare.projects.locations.datasets.dicomStores.deidentify" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsDicomStoresDeidentifyCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsDicomStoresDeidentifyCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDatasetsDicomStoresDeleteCall

type ProjectsLocationsDatasetsDicomStoresDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresDeleteCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsDicomStoresDeleteCall) Do

Do executes the "healthcare.projects.locations.datasets.dicomStores.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsDicomStoresDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsDicomStoresDeleteCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDatasetsDicomStoresDicomWebService added in v0.147.0

type ProjectsLocationsDatasetsDicomStoresDicomWebService struct {
	Studies *ProjectsLocationsDatasetsDicomStoresDicomWebStudiesService
	// contains filtered or unexported fields
}

func NewProjectsLocationsDatasetsDicomStoresDicomWebService added in v0.147.0

func NewProjectsLocationsDatasetsDicomStoresDicomWebService(s *Service) *ProjectsLocationsDatasetsDicomStoresDicomWebService

type ProjectsLocationsDatasetsDicomStoresDicomWebStudiesGetStudyMetricsCall added in v0.147.0

type ProjectsLocationsDatasetsDicomStoresDicomWebStudiesGetStudyMetricsCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresDicomWebStudiesGetStudyMetricsCall) Context added in v0.147.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsDicomStoresDicomWebStudiesGetStudyMetricsCall) Do added in v0.147.0

Do executes the "healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.getStudyMetrics" call. Any non-2xx status code is an error. Response headers are in either *StudyMetrics.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsDicomStoresDicomWebStudiesGetStudyMetricsCall) Fields added in v0.147.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsDicomStoresDicomWebStudiesGetStudyMetricsCall) Header added in v0.147.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDatasetsDicomStoresDicomWebStudiesGetStudyMetricsCall) IfNoneMatch added in v0.147.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsDatasetsDicomStoresDicomWebStudiesSeriesGetSeriesMetricsCall added in v0.147.0

type ProjectsLocationsDatasetsDicomStoresDicomWebStudiesSeriesGetSeriesMetricsCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresDicomWebStudiesSeriesGetSeriesMetricsCall) Context added in v0.147.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsDicomStoresDicomWebStudiesSeriesGetSeriesMetricsCall) Do added in v0.147.0

Do executes the "healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.getSeriesMetrics" call. Any non-2xx status code is an error. Response headers are in either *SeriesMetrics.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsDicomStoresDicomWebStudiesSeriesGetSeriesMetricsCall) Fields added in v0.147.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsDicomStoresDicomWebStudiesSeriesGetSeriesMetricsCall) Header added in v0.147.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDatasetsDicomStoresDicomWebStudiesSeriesGetSeriesMetricsCall) IfNoneMatch added in v0.147.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsDatasetsDicomStoresDicomWebStudiesSeriesService added in v0.147.0

type ProjectsLocationsDatasetsDicomStoresDicomWebStudiesSeriesService struct {
	// contains filtered or unexported fields
}

func NewProjectsLocationsDatasetsDicomStoresDicomWebStudiesSeriesService added in v0.147.0

func NewProjectsLocationsDatasetsDicomStoresDicomWebStudiesSeriesService(s *Service) *ProjectsLocationsDatasetsDicomStoresDicomWebStudiesSeriesService

func (*ProjectsLocationsDatasetsDicomStoresDicomWebStudiesSeriesService) GetSeriesMetrics added in v0.147.0

GetSeriesMetrics: GetSeriesMetrics returns metrics for a series.

  • series: The series resource path. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomS tores/{dicom_store_id}/dicomWeb/studies/{study_uid}/series/{series_uid}`.

type ProjectsLocationsDatasetsDicomStoresDicomWebStudiesService added in v0.147.0

type ProjectsLocationsDatasetsDicomStoresDicomWebStudiesService struct {
	Series *ProjectsLocationsDatasetsDicomStoresDicomWebStudiesSeriesService
	// contains filtered or unexported fields
}

func NewProjectsLocationsDatasetsDicomStoresDicomWebStudiesService added in v0.147.0

func NewProjectsLocationsDatasetsDicomStoresDicomWebStudiesService(s *Service) *ProjectsLocationsDatasetsDicomStoresDicomWebStudiesService

func (*ProjectsLocationsDatasetsDicomStoresDicomWebStudiesService) GetStudyMetrics added in v0.147.0

GetStudyMetrics: GetStudyMetrics returns metrics for a study.

  • study: The study resource path. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomS tores/{dicom_store_id}/dicomWeb/studies/{study_uid}`.

type ProjectsLocationsDatasetsDicomStoresExportCall

type ProjectsLocationsDatasetsDicomStoresExportCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresExportCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsDicomStoresExportCall) Do

Do executes the "healthcare.projects.locations.datasets.dicomStores.export" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsDicomStoresExportCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsDicomStoresExportCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDatasetsDicomStoresGetCall

type ProjectsLocationsDatasetsDicomStoresGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresGetCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsDicomStoresGetCall) Do

Do executes the "healthcare.projects.locations.datasets.dicomStores.get" call. Any non-2xx status code is an error. Response headers are in either *DicomStore.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsDicomStoresGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsDicomStoresGetCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDatasetsDicomStoresGetCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsDatasetsDicomStoresGetDICOMStoreMetricsCall added in v0.147.0

type ProjectsLocationsDatasetsDicomStoresGetDICOMStoreMetricsCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresGetDICOMStoreMetricsCall) Context added in v0.147.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsDicomStoresGetDICOMStoreMetricsCall) Do added in v0.147.0

Do executes the "healthcare.projects.locations.datasets.dicomStores.getDICOMStoreMetrics" call. Any non-2xx status code is an error. Response headers are in either *DicomStoreMetrics.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsDicomStoresGetDICOMStoreMetricsCall) Fields added in v0.147.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsDicomStoresGetDICOMStoreMetricsCall) Header added in v0.147.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDatasetsDicomStoresGetDICOMStoreMetricsCall) IfNoneMatch added in v0.147.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsDatasetsDicomStoresGetIamPolicyCall

type ProjectsLocationsDatasetsDicomStoresGetIamPolicyCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresGetIamPolicyCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsDicomStoresGetIamPolicyCall) Do

Do executes the "healthcare.projects.locations.datasets.dicomStores.getIamPolicy" call. Any non-2xx status code is an error. Response headers are in either *Policy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsDicomStoresGetIamPolicyCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsDicomStoresGetIamPolicyCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDatasetsDicomStoresGetIamPolicyCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsDatasetsDicomStoresGetIamPolicyCall) OptionsRequestedPolicyVersion

func (c *ProjectsLocationsDatasetsDicomStoresGetIamPolicyCall) OptionsRequestedPolicyVersion(optionsRequestedPolicyVersion int64) *ProjectsLocationsDatasetsDicomStoresGetIamPolicyCall

OptionsRequestedPolicyVersion sets the optional parameter "options.requestedPolicyVersion": The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).

type ProjectsLocationsDatasetsDicomStoresImportCall

type ProjectsLocationsDatasetsDicomStoresImportCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresImportCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsDicomStoresImportCall) Do

Do executes the "healthcare.projects.locations.datasets.dicomStores.import" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsDicomStoresImportCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsDicomStoresImportCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDatasetsDicomStoresListCall

type ProjectsLocationsDatasetsDicomStoresListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresListCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsDicomStoresListCall) Do

Do executes the "healthcare.projects.locations.datasets.dicomStores.list" call. Any non-2xx status code is an error. Response headers are in either *ListDicomStoresResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsDicomStoresListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsDicomStoresListCall) Filter

Filter sets the optional parameter "filter": Restricts stores returned to those matching a filter. The following syntax is available: * A string field value can be written as text inside quotation marks, for example "query text". The only valid relational operation for text fields is equality (`=`), where text is searched within the field, rather than having the field be equal to the text. For example, "Comment = great" returns messages with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. Only filtering on labels is supported. For example, `labels.key=value`.

func (*ProjectsLocationsDatasetsDicomStoresListCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDatasetsDicomStoresListCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsDatasetsDicomStoresListCall) PageSize

PageSize sets the optional parameter "pageSize": Limit on the number of DICOM stores to return in a single response. If not specified, 100 is used. May not be larger than 1000.

func (*ProjectsLocationsDatasetsDicomStoresListCall) PageToken

PageToken sets the optional parameter "pageToken": The next_page_token value returned from the previous List request, if any.

func (*ProjectsLocationsDatasetsDicomStoresListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsDatasetsDicomStoresPatchCall

type ProjectsLocationsDatasetsDicomStoresPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresPatchCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsDicomStoresPatchCall) Do

Do executes the "healthcare.projects.locations.datasets.dicomStores.patch" call. Any non-2xx status code is an error. Response headers are in either *DicomStore.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsDicomStoresPatchCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsDicomStoresPatchCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDatasetsDicomStoresPatchCall) UpdateMask

UpdateMask sets the optional parameter "updateMask": Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask

type ProjectsLocationsDatasetsDicomStoresSearchForInstancesCall

type ProjectsLocationsDatasetsDicomStoresSearchForInstancesCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresSearchForInstancesCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsDicomStoresSearchForInstancesCall) Do

Do executes the "healthcare.projects.locations.datasets.dicomStores.searchForInstances" call.

func (*ProjectsLocationsDatasetsDicomStoresSearchForInstancesCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsDicomStoresSearchForInstancesCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDatasetsDicomStoresSearchForInstancesCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsDatasetsDicomStoresSearchForSeriesCall

type ProjectsLocationsDatasetsDicomStoresSearchForSeriesCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresSearchForSeriesCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsDicomStoresSearchForSeriesCall) Do

Do executes the "healthcare.projects.locations.datasets.dicomStores.searchForSeries" call.

func (*ProjectsLocationsDatasetsDicomStoresSearchForSeriesCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsDicomStoresSearchForSeriesCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDatasetsDicomStoresSearchForSeriesCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsDatasetsDicomStoresSearchForStudiesCall

type ProjectsLocationsDatasetsDicomStoresSearchForStudiesCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresSearchForStudiesCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsDicomStoresSearchForStudiesCall) Do

Do executes the "healthcare.projects.locations.datasets.dicomStores.searchForStudies" call.

func (*ProjectsLocationsDatasetsDicomStoresSearchForStudiesCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsDicomStoresSearchForStudiesCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDatasetsDicomStoresSearchForStudiesCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsDatasetsDicomStoresService

type ProjectsLocationsDatasetsDicomStoresService struct {
	DicomWeb *ProjectsLocationsDatasetsDicomStoresDicomWebService

	Studies *ProjectsLocationsDatasetsDicomStoresStudiesService
	// contains filtered or unexported fields
}

func NewProjectsLocationsDatasetsDicomStoresService

func NewProjectsLocationsDatasetsDicomStoresService(s *Service) *ProjectsLocationsDatasetsDicomStoresService

func (*ProjectsLocationsDatasetsDicomStoresService) Create

Create: Creates a new DICOM store within the parent dataset.

- parent: The name of the dataset this DICOM store belongs to.

func (*ProjectsLocationsDatasetsDicomStoresService) Deidentify

Deidentify: De-identifies data from the source store and writes it to the destination store. The metadata field type is OperationMetadata. If the request is successful, the response field type is DeidentifyDicomStoreSummary. If errors occur, error is set. The LRO result may still be successful if de-identification fails for some DICOM instances. The output DICOM store will not contain these failed resources. Failed resource totals are tracked in Operation.metadata. Error details are also logged to Cloud Logging (see Viewing error logs in Cloud Logging (https://cloud.google.com/healthcare/docs/how-tos/logging)).

  • sourceStore: Source DICOM store resource name. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomS tores/{dicom_store_id}`.

func (*ProjectsLocationsDatasetsDicomStoresService) Delete

Delete: Deletes the specified DICOM store and removes all images that are contained within it.

- name: The resource name of the DICOM store to delete.

func (*ProjectsLocationsDatasetsDicomStoresService) Export

Export: Exports data to the specified destination by copying it from the DICOM store. Errors are also logged to Cloud Logging. For more information, see Viewing error logs in Cloud Logging (https://cloud.google.com/healthcare/docs/how-tos/logging). The metadata field type is OperationMetadata.

  • name: The DICOM store resource name from which to export the data. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomS tores/{dicom_store_id}`.

func (*ProjectsLocationsDatasetsDicomStoresService) Get

Get: Gets the specified DICOM store.

- name: The resource name of the DICOM store to get.

func (*ProjectsLocationsDatasetsDicomStoresService) GetDICOMStoreMetrics added in v0.147.0

GetDICOMStoreMetrics: Gets metrics associated with the DICOM store.

- name: The resource name of the DICOM store to get metrics for.

func (*ProjectsLocationsDatasetsDicomStoresService) GetIamPolicy

GetIamPolicy: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

func (*ProjectsLocationsDatasetsDicomStoresService) Import

Import: Imports data into the DICOM store by copying it from the specified source. Errors are logged to Cloud Logging. For more information, see Viewing error logs in Cloud Logging (https://cloud.google.com/healthcare/docs/how-tos/logging). The metadata field type is OperationMetadata.

  • name: The name of the DICOM store resource into which the data is imported. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomS tores/{dicom_store_id}`.

func (*ProjectsLocationsDatasetsDicomStoresService) List

List: Lists the DICOM stores in the given dataset.

- parent: Name of the dataset.

func (*ProjectsLocationsDatasetsDicomStoresService) Patch

Patch: Updates the specified DICOM store.

  • name: Identifier. Resource name of the DICOM store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomS tores/{dicom_store_id}`.

func (*ProjectsLocationsDatasetsDicomStoresService) SearchForInstances

SearchForInstances: SearchForInstances returns a list of matching instances. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForInstances, see Search transaction (https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see Search for DICOM data (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).

  • dicomWebPath: The path of the SearchForInstancesRequest DICOMweb request. For example, `instances`, `series/{series_uid}/instances`, or `studies/{study_uid}/instances`.
  • parent: The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomS tores/{dicom_store_id}`.

func (*ProjectsLocationsDatasetsDicomStoresService) SearchForSeries

SearchForSeries: SearchForSeries returns a list of matching series. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForSeries, see Search transaction (https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see Search for DICOM data (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).

  • dicomWebPath: The path of the SearchForSeries DICOMweb request. For example, `series` or `studies/{study_uid}/series`.
  • parent: The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomS tores/{dicom_store_id}`.

func (*ProjectsLocationsDatasetsDicomStoresService) SearchForStudies

SearchForStudies: SearchForStudies returns a list of matching studies. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForStudies, see Search transaction (https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForStudies, see Search for DICOM data (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).

  • dicomWebPath: The path of the SearchForStudies DICOMweb request. For example, `studies`.
  • parent: The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomS tores/{dicom_store_id}`.

func (*ProjectsLocationsDatasetsDicomStoresService) SetIamPolicy

SetIamPolicy: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

func (*ProjectsLocationsDatasetsDicomStoresService) StoreInstances

StoreInstances: StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). For details on the implementation of StoreInstances, see Store transaction (https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see Store DICOM data (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#store-dicom).

  • dicomWebPath: The path of the StoreInstances DICOMweb request. For example, `studies/[{study_uid}]`. Note that the `study_uid` is optional.
  • parent: The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomS tores/{dicom_store_id}`.

func (*ProjectsLocationsDatasetsDicomStoresService) TestIamPermissions

TestIamPermissions: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

type ProjectsLocationsDatasetsDicomStoresSetIamPolicyCall

type ProjectsLocationsDatasetsDicomStoresSetIamPolicyCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresSetIamPolicyCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsDicomStoresSetIamPolicyCall) Do

Do executes the "healthcare.projects.locations.datasets.dicomStores.setIamPolicy" call. Any non-2xx status code is an error. Response headers are in either *Policy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsDicomStoresSetIamPolicyCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsDicomStoresSetIamPolicyCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDatasetsDicomStoresStoreInstancesCall

type ProjectsLocationsDatasetsDicomStoresStoreInstancesCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresStoreInstancesCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsDicomStoresStoreInstancesCall) Do

Do executes the "healthcare.projects.locations.datasets.dicomStores.storeInstances" call.

func (*ProjectsLocationsDatasetsDicomStoresStoreInstancesCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsDicomStoresStoreInstancesCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDatasetsDicomStoresStudiesDeleteCall

type ProjectsLocationsDatasetsDicomStoresStudiesDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresStudiesDeleteCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsDicomStoresStudiesDeleteCall) Do

Do executes the "healthcare.projects.locations.datasets.dicomStores.studies.delete" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsDicomStoresStudiesDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsDicomStoresStudiesDeleteCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDatasetsDicomStoresStudiesRetrieveMetadataCall

type ProjectsLocationsDatasetsDicomStoresStudiesRetrieveMetadataCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresStudiesRetrieveMetadataCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsDicomStoresStudiesRetrieveMetadataCall) Do

Do executes the "healthcare.projects.locations.datasets.dicomStores.studies.retrieveMetadata" call.

func (*ProjectsLocationsDatasetsDicomStoresStudiesRetrieveMetadataCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsDicomStoresStudiesRetrieveMetadataCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDatasetsDicomStoresStudiesRetrieveMetadataCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsDatasetsDicomStoresStudiesRetrieveStudyCall

type ProjectsLocationsDatasetsDicomStoresStudiesRetrieveStudyCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresStudiesRetrieveStudyCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsDicomStoresStudiesRetrieveStudyCall) Do

Do executes the "healthcare.projects.locations.datasets.dicomStores.studies.retrieveStudy" call.

func (*ProjectsLocationsDatasetsDicomStoresStudiesRetrieveStudyCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsDicomStoresStudiesRetrieveStudyCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDatasetsDicomStoresStudiesRetrieveStudyCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsDatasetsDicomStoresStudiesSearchForInstancesCall

type ProjectsLocationsDatasetsDicomStoresStudiesSearchForInstancesCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresStudiesSearchForInstancesCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSearchForInstancesCall) Do

Do executes the "healthcare.projects.locations.datasets.dicomStores.studies.searchForInstances" call.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSearchForInstancesCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSearchForInstancesCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSearchForInstancesCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsDatasetsDicomStoresStudiesSearchForSeriesCall

type ProjectsLocationsDatasetsDicomStoresStudiesSearchForSeriesCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresStudiesSearchForSeriesCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSearchForSeriesCall) Do

Do executes the "healthcare.projects.locations.datasets.dicomStores.studies.searchForSeries" call.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSearchForSeriesCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSearchForSeriesCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSearchForSeriesCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsDatasetsDicomStoresStudiesSeriesDeleteCall

type ProjectsLocationsDatasetsDicomStoresStudiesSeriesDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesDeleteCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesDeleteCall) Do

Do executes the "healthcare.projects.locations.datasets.dicomStores.studies.series.delete" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesDeleteCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesDeleteCall

type ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesDeleteCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesDeleteCall) Do

Do executes the "healthcare.projects.locations.datasets.dicomStores.studies.series.instances.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesDeleteCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesFramesRetrieveFramesCall

type ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesFramesRetrieveFramesCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesFramesRetrieveFramesCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesFramesRetrieveFramesCall) Do

Do executes the "healthcare.projects.locations.datasets.dicomStores.studies.series.instances.frames.retrieveFrames" call.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesFramesRetrieveFramesCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesFramesRetrieveFramesCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesFramesRetrieveFramesCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesFramesRetrieveRenderedCall

type ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesFramesRetrieveRenderedCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesFramesRetrieveRenderedCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesFramesRetrieveRenderedCall) Do

Do executes the "healthcare.projects.locations.datasets.dicomStores.studies.series.instances.frames.retrieveRendered" call.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesFramesRetrieveRenderedCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesFramesRetrieveRenderedCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesFramesRetrieveRenderedCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesFramesService

type ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesFramesService struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesFramesService) RetrieveFrames

RetrieveFrames: RetrieveFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4}. For details on the implementation of RetrieveFrames, see DICOM frames (https://cloud.google.com/healthcare/docs/dicom#dicom_frames) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveFrames, see Retrieve DICOM data (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom).

  • dicomWebPath: The path of the RetrieveFrames DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}/frames/{f rame_list}`.
  • parent: The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomS tores/{dicom_store_id}`.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesFramesService) RetrieveRendered

RetrieveRendered: RetrieveRenderedFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers in an acceptable Rendered Media Type. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedFrames, see Rendered resources (https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedFrames, see Retrieve consumer image formats (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-consumer).

  • dicomWebPath: The path of the RetrieveRenderedFrames DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}/frames/{f rame_list}/rendered`.
  • parent: The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomS tores/{dicom_store_id}`.

type ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesRetrieveInstanceCall

type ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesRetrieveInstanceCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesRetrieveInstanceCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesRetrieveInstanceCall) Do

Do executes the "healthcare.projects.locations.datasets.dicomStores.studies.series.instances.retrieveInstance" call.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesRetrieveInstanceCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesRetrieveInstanceCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesRetrieveInstanceCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesRetrieveMetadataCall

type ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesRetrieveMetadataCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesRetrieveMetadataCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesRetrieveMetadataCall) Do

Do executes the "healthcare.projects.locations.datasets.dicomStores.studies.series.instances.retrieveMetadata" call.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesRetrieveMetadataCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesRetrieveMetadataCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesRetrieveMetadataCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesRetrieveRenderedCall

type ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesRetrieveRenderedCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesRetrieveRenderedCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesRetrieveRenderedCall) Do

Do executes the "healthcare.projects.locations.datasets.dicomStores.studies.series.instances.retrieveRendered" call.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesRetrieveRenderedCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesRetrieveRenderedCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesRetrieveRenderedCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesService

type ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesService struct {
	Frames *ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesFramesService
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesService) Delete

Delete: DeleteInstance deletes an instance associated with the given study, series, and SOP Instance UID. Delete requests are equivalent to the GET requests specified in the Retrieve transaction. Study and series search results can take a few seconds to be updated after an instance is deleted using DeleteInstance. For samples that show how to call DeleteInstance, see Delete a study, series, or instance (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#delete-dicom).

  • dicomWebPath: The path of the DeleteInstance request. For example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}`.
  • parent: The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomS tores/{dicom_store_id}`.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesService) RetrieveInstance

RetrieveInstance: RetrieveInstance returns instance associated with the given study, series, and SOP Instance UID. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstance, see DICOM study/series/instances (https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) and DICOM instances (https://cloud.google.com/healthcare/docs/dicom#dicom_instances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstance, see Retrieve an instance (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-instance).

  • dicomWebPath: The path of the RetrieveInstance DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}`.
  • parent: The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomS tores/{dicom_store_id}`.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesService) RetrieveMetadata

RetrieveMetadata: RetrieveInstanceMetadata returns instance associated with the given study, series, and SOP Instance UID presented as metadata with the bulk data removed. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstanceMetadata, see Metadata resources (https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstanceMetadata, see Retrieve metadata (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata).

  • dicomWebPath: The path of the RetrieveInstanceMetadata DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}/metadata` .
  • parent: The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomS tores/{dicom_store_id}`.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesService) RetrieveRendered

RetrieveRendered: RetrieveRenderedInstance returns instance associated with the given study, series, and SOP Instance UID in an acceptable Rendered Media Type. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedInstance, see Rendered resources (https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedInstance, see Retrieve consumer image formats (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-consumer).

  • dicomWebPath: The path of the RetrieveRenderedInstance DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}/rendered` .
  • parent: The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomS tores/{dicom_store_id}`.

type ProjectsLocationsDatasetsDicomStoresStudiesSeriesRetrieveMetadataCall

type ProjectsLocationsDatasetsDicomStoresStudiesSeriesRetrieveMetadataCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesRetrieveMetadataCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesRetrieveMetadataCall) Do

Do executes the "healthcare.projects.locations.datasets.dicomStores.studies.series.retrieveMetadata" call.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesRetrieveMetadataCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesRetrieveMetadataCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesRetrieveMetadataCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsDatasetsDicomStoresStudiesSeriesRetrieveSeriesCall

type ProjectsLocationsDatasetsDicomStoresStudiesSeriesRetrieveSeriesCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesRetrieveSeriesCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesRetrieveSeriesCall) Do

Do executes the "healthcare.projects.locations.datasets.dicomStores.studies.series.retrieveSeries" call.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesRetrieveSeriesCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesRetrieveSeriesCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesRetrieveSeriesCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsDatasetsDicomStoresStudiesSeriesSearchForInstancesCall

type ProjectsLocationsDatasetsDicomStoresStudiesSeriesSearchForInstancesCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesSearchForInstancesCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesSearchForInstancesCall) Do

Do executes the "healthcare.projects.locations.datasets.dicomStores.studies.series.searchForInstances" call.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesSearchForInstancesCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesSearchForInstancesCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesSearchForInstancesCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsDatasetsDicomStoresStudiesSeriesService

type ProjectsLocationsDatasetsDicomStoresStudiesSeriesService struct {
	Instances *ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesService
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesService) Delete

Delete: DeleteSeries deletes all instances within the given study and series. Delete requests are equivalent to the GET requests specified in the Retrieve transaction. The method returns an Operation which will be marked successful when the deletion is complete. Warning: Instances cannot be inserted into a series that is being deleted by an operation until the operation completes. For samples that show how to call DeleteSeries, see Delete a study, series, or instance (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#delete-dicom).

  • dicomWebPath: The path of the DeleteSeries request. For example, `studies/{study_uid}/series/{series_uid}`.
  • parent: The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomS tores/{dicom_store_id}`.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesService) RetrieveMetadata

RetrieveMetadata: RetrieveSeriesMetadata returns instance associated with the given study and series, presented as metadata with the bulk data removed. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeriesMetadata, see Metadata resources (https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeriesMetadata, see Retrieve metadata (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata).

  • dicomWebPath: The path of the RetrieveSeriesMetadata DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}/metadata`.
  • parent: The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomS tores/{dicom_store_id}`.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesService) RetrieveSeries

RetrieveSeries: RetrieveSeries returns all instances within the given study and series. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeries, see DICOM study/series/instances (https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeries, see Retrieve DICOM data (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom).

  • dicomWebPath: The path of the RetrieveSeries DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}`.
  • parent: The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomS tores/{dicom_store_id}`.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesService) SearchForInstances

SearchForInstances: SearchForInstances returns a list of matching instances. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForInstances, see Search transaction (https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see Search for DICOM data (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).

  • dicomWebPath: The path of the SearchForInstancesRequest DICOMweb request. For example, `instances`, `series/{series_uid}/instances`, or `studies/{study_uid}/instances`.
  • parent: The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomS tores/{dicom_store_id}`.

type ProjectsLocationsDatasetsDicomStoresStudiesService

type ProjectsLocationsDatasetsDicomStoresStudiesService struct {
	Series *ProjectsLocationsDatasetsDicomStoresStudiesSeriesService
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresStudiesService) Delete

Delete: DeleteStudy deletes all instances within the given study. Delete requests are equivalent to the GET requests specified in the Retrieve transaction. The method returns an Operation which will be marked successful when the deletion is complete. Warning: Instances cannot be inserted into a study that is being deleted by an operation until the operation completes. For samples that show how to call DeleteStudy, see Delete a study, series, or instance (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#delete-dicom).

  • dicomWebPath: The path of the DeleteStudy request. For example, `studies/{study_uid}`.
  • parent: .

func (*ProjectsLocationsDatasetsDicomStoresStudiesService) RetrieveMetadata

RetrieveMetadata: RetrieveStudyMetadata returns instance associated with the given study presented as metadata with the bulk data removed. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudyMetadata, see Metadata resources (https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudyMetadata, see Retrieve metadata (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata).

  • dicomWebPath: The path of the RetrieveStudyMetadata DICOMweb request. For example, `studies/{study_uid}/metadata`.
  • parent: The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomS tores/{dicom_store_id}`.

func (*ProjectsLocationsDatasetsDicomStoresStudiesService) RetrieveStudy

RetrieveStudy: RetrieveStudy returns all instances within the given study. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudy, see DICOM study/series/instances (https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudy, see Retrieve DICOM data (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom).

  • dicomWebPath: The path of the RetrieveStudy DICOMweb request. For example, `studies/{study_uid}`.
  • parent: The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomS tores/{dicom_store_id}`.

func (*ProjectsLocationsDatasetsDicomStoresStudiesService) SearchForInstances

SearchForInstances: SearchForInstances returns a list of matching instances. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForInstances, see Search transaction (https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see Search for DICOM data (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).

  • dicomWebPath: The path of the SearchForInstancesRequest DICOMweb request. For example, `instances`, `series/{series_uid}/instances`, or `studies/{study_uid}/instances`.
  • parent: The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomS tores/{dicom_store_id}`.

func (*ProjectsLocationsDatasetsDicomStoresStudiesService) SearchForSeries

SearchForSeries: SearchForSeries returns a list of matching series. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForSeries, see Search transaction (https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see Search for DICOM data (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).

  • dicomWebPath: The path of the SearchForSeries DICOMweb request. For example, `series` or `studies/{study_uid}/series`.
  • parent: The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomS tores/{dicom_store_id}`.

func (*ProjectsLocationsDatasetsDicomStoresStudiesService) StoreInstances

StoreInstances: StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). For details on the implementation of StoreInstances, see Store transaction (https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see Store DICOM data (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#store-dicom).

  • dicomWebPath: The path of the StoreInstances DICOMweb request. For example, `studies/[{study_uid}]`. Note that the `study_uid` is optional.
  • parent: The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomS tores/{dicom_store_id}`.

type ProjectsLocationsDatasetsDicomStoresStudiesStoreInstancesCall

type ProjectsLocationsDatasetsDicomStoresStudiesStoreInstancesCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresStudiesStoreInstancesCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsDicomStoresStudiesStoreInstancesCall) Do

Do executes the "healthcare.projects.locations.datasets.dicomStores.studies.storeInstances" call.

func (*ProjectsLocationsDatasetsDicomStoresStudiesStoreInstancesCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsDicomStoresStudiesStoreInstancesCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDatasetsDicomStoresTestIamPermissionsCall

type ProjectsLocationsDatasetsDicomStoresTestIamPermissionsCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresTestIamPermissionsCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsDicomStoresTestIamPermissionsCall) Do

Do executes the "healthcare.projects.locations.datasets.dicomStores.testIamPermissions" call. Any non-2xx status code is an error. Response headers are in either *TestIamPermissionsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsDicomStoresTestIamPermissionsCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsDicomStoresTestIamPermissionsCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDatasetsFhirStoresCreateCall

type ProjectsLocationsDatasetsFhirStoresCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsFhirStoresCreateCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsFhirStoresCreateCall) Do

Do executes the "healthcare.projects.locations.datasets.fhirStores.create" call. Any non-2xx status code is an error. Response headers are in either *FhirStore.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsFhirStoresCreateCall) FhirStoreId

FhirStoreId sets the optional parameter "fhirStoreId": Required. The ID of the FHIR store that is being created. The string must match the following regex: `[\p{L}\p{N}_\-\.]{1,256}`.

func (*ProjectsLocationsDatasetsFhirStoresCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsFhirStoresCreateCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDatasetsFhirStoresDeidentifyCall

type ProjectsLocationsDatasetsFhirStoresDeidentifyCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsFhirStoresDeidentifyCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsFhirStoresDeidentifyCall) Do

Do executes the "healthcare.projects.locations.datasets.fhirStores.deidentify" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsFhirStoresDeidentifyCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsFhirStoresDeidentifyCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDatasetsFhirStoresDeleteCall

type ProjectsLocationsDatasetsFhirStoresDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsFhirStoresDeleteCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsFhirStoresDeleteCall) Do

Do executes the "healthcare.projects.locations.datasets.fhirStores.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsFhirStoresDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsFhirStoresDeleteCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDatasetsFhirStoresExportCall

type ProjectsLocationsDatasetsFhirStoresExportCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsFhirStoresExportCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsFhirStoresExportCall) Do

Do executes the "healthcare.projects.locations.datasets.fhirStores.export" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsFhirStoresExportCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsFhirStoresExportCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDatasetsFhirStoresFhirCapabilitiesCall

type ProjectsLocationsDatasetsFhirStoresFhirCapabilitiesCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsFhirStoresFhirCapabilitiesCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsFhirStoresFhirCapabilitiesCall) Do

Do executes the "healthcare.projects.locations.datasets.fhirStores.fhir.capabilities" call.

func (*ProjectsLocationsDatasetsFhirStoresFhirCapabilitiesCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsFhirStoresFhirCapabilitiesCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDatasetsFhirStoresFhirCapabilitiesCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsDatasetsFhirStoresFhirConditionalDeleteCall added in v0.137.0

type ProjectsLocationsDatasetsFhirStoresFhirConditionalDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsFhirStoresFhirConditionalDeleteCall) Context added in v0.137.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsFhirStoresFhirConditionalDeleteCall) Do added in v0.137.0

Do executes the "healthcare.projects.locations.datasets.fhirStores.fhir.conditionalDelete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsFhirStoresFhirConditionalDeleteCall) Fields added in v0.137.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsFhirStoresFhirConditionalDeleteCall) Header added in v0.137.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDatasetsFhirStoresFhirConditionalPatchCall added in v0.137.0

type ProjectsLocationsDatasetsFhirStoresFhirConditionalPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsFhirStoresFhirConditionalPatchCall) Context added in v0.137.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsFhirStoresFhirConditionalPatchCall) Do added in v0.137.0

Do executes the "healthcare.projects.locations.datasets.fhirStores.fhir.conditionalPatch" call.

func (*ProjectsLocationsDatasetsFhirStoresFhirConditionalPatchCall) Fields added in v0.137.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsFhirStoresFhirConditionalPatchCall) Header added in v0.137.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDatasetsFhirStoresFhirConditionalUpdateCall added in v0.137.0

type ProjectsLocationsDatasetsFhirStoresFhirConditionalUpdateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsFhirStoresFhirConditionalUpdateCall) Context added in v0.137.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsFhirStoresFhirConditionalUpdateCall) Do added in v0.137.0

Do executes the "healthcare.projects.locations.datasets.fhirStores.fhir.conditionalUpdate" call.

func (*ProjectsLocationsDatasetsFhirStoresFhirConditionalUpdateCall) Fields added in v0.137.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsFhirStoresFhirConditionalUpdateCall) Header added in v0.137.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDatasetsFhirStoresFhirCreateCall

type ProjectsLocationsDatasetsFhirStoresFhirCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsFhirStoresFhirCreateCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsFhirStoresFhirCreateCall) Do

Do executes the "healthcare.projects.locations.datasets.fhirStores.fhir.create" call.

func (*ProjectsLocationsDatasetsFhirStoresFhirCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsFhirStoresFhirCreateCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDatasetsFhirStoresFhirDeleteCall

type ProjectsLocationsDatasetsFhirStoresFhirDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsFhirStoresFhirDeleteCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsFhirStoresFhirDeleteCall) Do

Do executes the "healthcare.projects.locations.datasets.fhirStores.fhir.delete" call.

func (*ProjectsLocationsDatasetsFhirStoresFhirDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsFhirStoresFhirDeleteCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDatasetsFhirStoresFhirExecuteBundleCall

type ProjectsLocationsDatasetsFhirStoresFhirExecuteBundleCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsFhirStoresFhirExecuteBundleCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsFhirStoresFhirExecuteBundleCall) Do

Do executes the "healthcare.projects.locations.datasets.fhirStores.fhir.executeBundle" call.

func (*ProjectsLocationsDatasetsFhirStoresFhirExecuteBundleCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsFhirStoresFhirExecuteBundleCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDatasetsFhirStoresFhirHistoryCall

type ProjectsLocationsDatasetsFhirStoresFhirHistoryCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsFhirStoresFhirHistoryCall) At

At sets the optional parameter "_at": Only include resource versions that were current at some point during the time period specified in the date time value. The date parameter format is yyyy-mm-ddThh:mm:ss[Z|(+|-)hh:mm] Clients may specify any of the following: * An entire year: `_at=2019` * An entire month: `_at=2019-01` * A specific day: `_at=2019-01-20` * A specific second: `_at=2018-12-31T23:59:58Z`

func (*ProjectsLocationsDatasetsFhirStoresFhirHistoryCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsFhirStoresFhirHistoryCall) Count

Count sets the optional parameter "_count": The maximum number of search results on a page. If not specified, 100 is used. May not be larger than 1000.

func (*ProjectsLocationsDatasetsFhirStoresFhirHistoryCall) Do

Do executes the "healthcare.projects.locations.datasets.fhirStores.fhir.history" call.

func (*ProjectsLocationsDatasetsFhirStoresFhirHistoryCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsFhirStoresFhirHistoryCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDatasetsFhirStoresFhirHistoryCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsDatasetsFhirStoresFhirHistoryCall) PageToken

PageToken sets the optional parameter "_page_token": Used to retrieve the first, previous, next, or last page of resource versions when using pagination. Value should be set to the value of `_page_token` set in next or previous page links' URLs. Next and previous page are returned in the response bundle's links field, where `link.relation` is "previous" or "next". Omit `_page_token` if no previous request has been made.

func (*ProjectsLocationsDatasetsFhirStoresFhirHistoryCall) Since

Since sets the optional parameter "_since": Only include resource versions that were created at or after the given instant in time. The instant in time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz (for example 2015-02-07T13:28:17.239+02:00 or 2017-01-01T00:00:00Z). The time must be specified to the second and include a time zone.

type ProjectsLocationsDatasetsFhirStoresFhirPatchCall

type ProjectsLocationsDatasetsFhirStoresFhirPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsFhirStoresFhirPatchCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsFhirStoresFhirPatchCall) Do

Do executes the "healthcare.projects.locations.datasets.fhirStores.fhir.patch" call.

func (*ProjectsLocationsDatasetsFhirStoresFhirPatchCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsFhirStoresFhirPatchCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDatasetsFhirStoresFhirPatientEverythingCall

type ProjectsLocationsDatasetsFhirStoresFhirPatientEverythingCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsFhirStoresFhirPatientEverythingCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsFhirStoresFhirPatientEverythingCall) Count

Count sets the optional parameter "_count": Maximum number of resources in a page. If not specified, 100 is used. May not be larger than 1000.

func (*ProjectsLocationsDatasetsFhirStoresFhirPatientEverythingCall) Do

Do executes the "healthcare.projects.locations.datasets.fhirStores.fhir.Patient-everything" call.

func (*ProjectsLocationsDatasetsFhirStoresFhirPatientEverythingCall) End

End sets the optional parameter "end": The response includes records prior to the end date. The date uses the format YYYY-MM-DD. If no end date is provided, all records subsequent to the start date are in scope.

func (*ProjectsLocationsDatasetsFhirStoresFhirPatientEverythingCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsFhirStoresFhirPatientEverythingCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDatasetsFhirStoresFhirPatientEverythingCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsDatasetsFhirStoresFhirPatientEverythingCall) PageToken

PageToken sets the optional parameter "_page_token": Used to retrieve the next or previous page of results when using pagination. Set `_page_token` to the value of _page_token set in next or previous page links' url. Next and previous page are returned in the response bundle's links field, where `link.relation` is "previous" or "next". Omit `_page_token` if no previous request has been made.

func (*ProjectsLocationsDatasetsFhirStoresFhirPatientEverythingCall) Since added in v0.30.0

Since sets the optional parameter "_since": If provided, only resources updated after this time are returned. The time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. For example, `2015-02-07T13:28:17.239+02:00` or `2017-01-01T00:00:00Z`. The time must be specified to the second and include a time zone.

func (*ProjectsLocationsDatasetsFhirStoresFhirPatientEverythingCall) Start

Start sets the optional parameter "start": The response includes records subsequent to the start date. The date uses the format YYYY-MM-DD. If no start date is provided, all records prior to the end date are in scope.

func (*ProjectsLocationsDatasetsFhirStoresFhirPatientEverythingCall) Type added in v0.30.0

Type sets the optional parameter "_type": String of comma-delimited FHIR resource types. If provided, only resources of the specified resource type(s) are returned. Specifying multiple `_type` parameters isn't supported. For example, the result of `_type=Observation&_type=Encounter` is undefined. Use `_type=Observation,Encounter` instead.

type ProjectsLocationsDatasetsFhirStoresFhirReadCall

type ProjectsLocationsDatasetsFhirStoresFhirReadCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsFhirStoresFhirReadCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsFhirStoresFhirReadCall) Do

Do executes the "healthcare.projects.locations.datasets.fhirStores.fhir.read" call.

func (*ProjectsLocationsDatasetsFhirStoresFhirReadCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsFhirStoresFhirReadCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDatasetsFhirStoresFhirReadCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsDatasetsFhirStoresFhirResourcePurgeCall

type ProjectsLocationsDatasetsFhirStoresFhirResourcePurgeCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsFhirStoresFhirResourcePurgeCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsFhirStoresFhirResourcePurgeCall) Do

Do executes the "healthcare.projects.locations.datasets.fhirStores.fhir.Resource-purge" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsFhirStoresFhirResourcePurgeCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsFhirStoresFhirResourcePurgeCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDatasetsFhirStoresFhirResourceValidateCall added in v0.64.0

type ProjectsLocationsDatasetsFhirStoresFhirResourceValidateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsFhirStoresFhirResourceValidateCall) Context added in v0.64.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsFhirStoresFhirResourceValidateCall) Do added in v0.64.0

Do executes the "healthcare.projects.locations.datasets.fhirStores.fhir.Resource-validate" call.

func (*ProjectsLocationsDatasetsFhirStoresFhirResourceValidateCall) Fields added in v0.64.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsFhirStoresFhirResourceValidateCall) Header added in v0.64.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDatasetsFhirStoresFhirResourceValidateCall) Profile added in v0.64.0

Profile sets the optional parameter "profile": Required. The canonical URL of a profile that this resource should be validated against. For example, to validate a Patient resource against the US Core Patient profile this parameter would be `http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient`. A StructureDefinition with this canonical URL must exist in the FHIR store.

type ProjectsLocationsDatasetsFhirStoresFhirSearchCall

type ProjectsLocationsDatasetsFhirStoresFhirSearchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsFhirStoresFhirSearchCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsFhirStoresFhirSearchCall) Do

Do executes the "healthcare.projects.locations.datasets.fhirStores.fhir.search" call.

func (*ProjectsLocationsDatasetsFhirStoresFhirSearchCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsFhirStoresFhirSearchCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDatasetsFhirStoresFhirSearchTypeCall added in v0.38.0

type ProjectsLocationsDatasetsFhirStoresFhirSearchTypeCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsFhirStoresFhirSearchTypeCall) Context added in v0.38.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsFhirStoresFhirSearchTypeCall) Do added in v0.38.0

Do executes the "healthcare.projects.locations.datasets.fhirStores.fhir.search-type" call.

func (*ProjectsLocationsDatasetsFhirStoresFhirSearchTypeCall) Fields added in v0.38.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsFhirStoresFhirSearchTypeCall) Header added in v0.38.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDatasetsFhirStoresFhirService

type ProjectsLocationsDatasetsFhirStoresFhirService struct {
	// contains filtered or unexported fields
}

func NewProjectsLocationsDatasetsFhirStoresFhirService

func NewProjectsLocationsDatasetsFhirStoresFhirService(s *Service) *ProjectsLocationsDatasetsFhirStoresFhirService

func (*ProjectsLocationsDatasetsFhirStoresFhirService) Capabilities

Capabilities: Gets the FHIR capability statement (STU3 (http://hl7.org/implement/standards/fhir/STU3/capabilitystatement.html), R4 (http://hl7.org/implement/standards/fhir/R4/capabilitystatement.html)), or the conformance statement (http://hl7.org/implement/standards/fhir/DSTU2/conformance.html) in the DSTU2 case for the store, which contains a description of functionality supported by the server. Implements the FHIR standard capabilities interaction (STU3 (http://hl7.org/implement/standards/fhir/STU3/http.html#capabilities), R4 (http://hl7.org/implement/standards/fhir/R4/http.html#capabilities)), or the conformance interaction (http://hl7.org/implement/standards/fhir/DSTU2/http.html#conformance) in the DSTU2 case. On success, the response body contains a JSON-encoded representation of a `CapabilityStatement` resource.

- name: Name of the FHIR store to retrieve the capabilities for.

func (*ProjectsLocationsDatasetsFhirStoresFhirService) ConditionalDelete added in v0.137.0

ConditionalDelete: Deletes a FHIR resource that match an identifier search query. Implements the FHIR standard conditional delete interaction, limited to searching by resource identifier. If multiple resources match, 412 Precondition Failed error will be returned. Search term for identifier should be in the pattern `identifier=system|value` or `identifier=value` - similar to the `search` method on resources with a specific identifier. Note: Unless resource versioning is disabled by setting the disable_resource_versioning flag on the FHIR store, the deleted resource is moved to a history repository that can still be retrieved through vread and related methods, unless they are removed by the purge method. For samples that show how to call `conditionalDelete`, see Conditionally deleting a FHIR resource (https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#conditionally_deleting_a_fhir_resource).

func (*ProjectsLocationsDatasetsFhirStoresFhirService) ConditionalPatch added in v0.137.0

ConditionalPatch: If a resource is found with the identifier specified in the query parameters, updates part of that resource by applying the operations specified in a JSON Patch (http://jsonpatch.com/) document. Implements the FHIR standard conditional patch interaction, limited to searching by resource identifier. DSTU2 doesn't define a conditional patch method, but the server supports it in the same way it supports STU3. Search term for identifier should be in the pattern `identifier=system|value` or `identifier=value` - similar to the `search` method on resources with a specific identifier. If the search criteria identify more than one match, the request returns a `412 Precondition Failed` error. The request body must contain a JSON Patch document, and the request headers must contain `Content-Type: application/json-patch+json`. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `conditionalPatch`, see Conditionally patching a FHIR resource (https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#conditionally_patching_a_fhir_resource).

func (*ProjectsLocationsDatasetsFhirStoresFhirService) ConditionalUpdate added in v0.137.0

ConditionalUpdate: If a resource is found with the identifier specified in the query parameters, updates the entire contents of that resource. Implements the FHIR standard conditional update interaction, limited to searching by resource identifier. Search term for identifier should be in the pattern `identifier=system|value` or `identifier=value` - similar to the `search` method on resources with a specific identifier. If the search criteria identify more than one match, the request returns a `412 Precondition Failed` error. If the search criteria identify zero matches, and the supplied resource body contains an `id`, and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. 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. If the search criteria identify zero matches, and the supplied resource body does not contain an `id`, the resource is created with a server-assigned ID as per the create method. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `conditionalUpdate`, see Conditionally updating a FHIR resource (https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#conditionally_updating_a_fhir_resource).

func (*ProjectsLocationsDatasetsFhirStoresFhirService) Create

Create: Creates a FHIR resource. Implements the FHIR standard create interaction (DSTU2 (http://hl7.org/implement/standards/fhir/DSTU2/http.html#create), STU3 (http://hl7.org/implement/standards/fhir/STU3/http.html#create), R4 (http://hl7.org/implement/standards/fhir/R4/http.html#create)), which creates a new resource with a server-assigned resource ID. Also supports the FHIR standard conditional create interaction (DSTU2 (https://hl7.org/implement/standards/fhir/DSTU2/http.html#ccreate), STU3 (https://hl7.org/implement/standards/fhir/STU3/http.html#ccreate), R4 (https://hl7.org/implement/standards/fhir/R4/http.html#ccreate)), specified by supplying an `If-None-Exist` header containing a FHIR search query, limited to searching by resource identifier. If no resources match this search query, the server processes the create operation as normal. When using conditional create, the search term for identifier should be in the pattern `identifier=system|value` or `identifier=value` - similar to the `search` method on resources with a specific identifier. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. On success, the response body contains a JSON-encoded representation of the resource as it was created on the server, including the server-assigned resource ID and version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `create`, see Creating a FHIR resource (https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#creating_a_fhir_resource).

func (*ProjectsLocationsDatasetsFhirStoresFhirService) Delete

Delete: Deletes a FHIR resource. Implements the FHIR standard delete interaction (DSTU2 (http://hl7.org/implement/standards/fhir/DSTU2/http.html#delete), STU3 (http://hl7.org/implement/standards/fhir/STU3/http.html#delete), R4 (http://hl7.org/implement/standards/fhir/R4/http.html#delete)). Note: Unless resource versioning is disabled by setting the disable_resource_versioning flag on the FHIR store, the deleted resources will be moved to a history repository that can still be retrieved through vread and related methods, unless they are removed by the purge method. For samples that show how to call `delete`, see Deleting a FHIR resource (https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#deleting_a_fhir_resource).

- name: The name of the resource to delete.

func (*ProjectsLocationsDatasetsFhirStoresFhirService) ExecuteBundle

ExecuteBundle: Executes all the requests in the given Bundle. Implements the FHIR standard batch/transaction interaction (DSTU2 (https://hl7.org/implement/standards/fhir/DSTU2/http.html#transaction), STU3 (https://hl7.org/implement/standards/fhir/STU3/http.html#transaction), R4 (https://hl7.org/implement/standards/fhir/R4/http.html#transaction)). Supports all interactions within a bundle, except search. This method accepts Bundles of type `batch` and `transaction`, processing them according to the batch processing rules (DSTU2 (https://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.1), STU3 (https://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.1), R4 (https://hl7.org/implement/standards/fhir/R4/http.html#brules)) and transaction processing rules (DSTU2 (https://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.2), STU3 (https://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.2), R4 (https://hl7.org/implement/standards/fhir/R4/http.html#trules)). The request body must contain a JSON-encoded FHIR `Bundle` resource, and the request headers must contain `Content-Type: application/fhir+json`. For a batch bundle or a successful transaction, the response body contains a JSON-encoded representation of a `Bundle` resource of type `batch-response` or `transaction-response` containing one entry for each entry in the request, with the outcome of processing the entry. In the case of an error for a transaction bundle, the response body contains a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. This method checks permissions for each request in the bundle. The `executeBundle` permission is required to call this method, but you must also grant sufficient permissions to execute the individual requests in the bundle. For example, if the bundle contains a request to create a FHIR resource, the caller must also have been granted the `healthcare.fhirResources.create` permission. You can use audit logs to view the permissions for `executeBundle` and each request in the bundle. For more information, see Viewing Cloud Audit logs (https://cloud.google.com/healthcare-api/docs/how-tos/audit-logging). For samples that show how to call `executeBundle`, see Managing FHIR resources using FHIR bundles (https://cloud.google.com/healthcare/docs/how-tos/fhir-bundles).

- parent: Name of the FHIR store in which this bundle will be executed.

func (*ProjectsLocationsDatasetsFhirStoresFhirService) History

History: Lists all the versions of a resource (including the current version and deleted versions) from the FHIR store. Implements the per-resource form of the FHIR standard history interaction (DSTU2 (http://hl7.org/implement/standards/fhir/DSTU2/http.html#history), STU3 (http://hl7.org/implement/standards/fhir/STU3/http.html#history), R4 (http://hl7.org/implement/standards/fhir/R4/http.html#history)). On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `history`, containing the version history sorted from most recent to oldest versions. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `history`, see Listing FHIR resource versions (https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#listing_fhir_resource_versions).

- name: The name of the resource to retrieve.

func (*ProjectsLocationsDatasetsFhirStoresFhirService) Patch

Patch: Updates part of an existing resource by applying the operations specified in a JSON Patch (http://jsonpatch.com/) document. Implements the FHIR standard patch interaction (STU3 (http://hl7.org/implement/standards/fhir/STU3/http.html#patch), R4 (http://hl7.org/implement/standards/fhir/R4/http.html#patch)). DSTU2 doesn't define a patch method, but the server supports it in the same way it supports STU3. The request body must contain a JSON Patch document, and the request headers must contain `Content-Type: application/json-patch+json`. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `patch`, see Patching a FHIR resource (https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#patching_a_fhir_resource).

- name: The name of the resource to update.

func (*ProjectsLocationsDatasetsFhirStoresFhirService) PatientEverything

PatientEverything: Retrieves a Patient resource and resources related to that patient. Implements the FHIR extended operation Patient-everything (DSTU2 (http://hl7.org/implement/standards/fhir/DSTU2/patient-operations.html#everything), STU3 (http://hl7.org/implement/standards/fhir/STU3/patient-operations.html#everything), R4 (http://hl7.org/implement/standards/fhir/R4/patient-operations.html#everything)). On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the operation. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The resources in scope for the response are: * The patient resource itself. * All the resources directly referenced by the patient resource. * Resources directly referencing the patient resource that meet the inclusion criteria. The inclusion criteria are based on the membership rules in the patient compartment definition (DSTU2 (http://hl7.org/fhir/DSTU2/compartment-patient.html), STU3 (http://www.hl7.org/fhir/stu3/compartmentdefinition-patient.html), R4 (http://hl7.org/fhir/R4/compartmentdefinition-patient.html)), which details the eligible resource types and referencing search parameters. For samples that show how to call `Patient-everything`, see Getting all patient compartment resources (https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#getting_all_patient_compartment_resources).

  • name: Name of the `Patient` resource for which the information is required.

func (*ProjectsLocationsDatasetsFhirStoresFhirService) Read

Read: Gets the contents of a FHIR resource. Implements the FHIR standard read interaction (DSTU2 (http://hl7.org/implement/standards/fhir/DSTU2/http.html#read), STU3 (http://hl7.org/implement/standards/fhir/STU3/http.html#read), R4 (http://hl7.org/implement/standards/fhir/R4/http.html#read)). Also supports the FHIR standard conditional read interaction (DSTU2 (http://hl7.org/implement/standards/fhir/DSTU2/http.html#cread), STU3 (http://hl7.org/implement/standards/fhir/STU3/http.html#cread), R4 (http://hl7.org/implement/standards/fhir/R4/http.html#cread)) specified by supplying an `If-Modified-Since` header with a date/time value or an `If-None-Match` header with an ETag value. On success, the response body contains a JSON-encoded representation of the resource. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `read`, see Getting a FHIR resource (https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#getting_a_fhir_resource).

- name: The name of the resource to retrieve.

func (*ProjectsLocationsDatasetsFhirStoresFhirService) ResourcePurge

ResourcePurge: Deletes all the historical versions of a resource (excluding the current version) from the FHIR store. To remove all versions of a resource, first delete the current version and then call this method. This is not a FHIR standard operation. For samples that show how to call `Resource-purge`, see Deleting historical versions of a FHIR resource (https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#deleting_historical_versions_of_a_fhir_resource).

- name: The name of the resource to purge.

func (*ProjectsLocationsDatasetsFhirStoresFhirService) ResourceValidate added in v0.64.0

ResourceValidate: Validates an input FHIR resource's conformance to its profiles and the profiles configured on the FHIR store. Implements the FHIR extended operation $validate (DSTU2 (http://hl7.org/implement/standards/fhir/DSTU2/resource-operations.html#validate), STU3 (http://hl7.org/implement/standards/fhir/STU3/resource-operations.html#validate), or R4 (http://hl7.org/implement/standards/fhir/R4/resource-operation-validate.html)). The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. The `Parameters` input syntax is not supported. The `profile` query parameter can be used to request that the resource only be validated against a specific profile. If a profile with the given URL cannot be found in the FHIR store then an error is returned. Errors generated by validation contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead.

func (*ProjectsLocationsDatasetsFhirStoresFhirService) Search

Search: Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction (DSTU2 (http://hl7.org/implement/standards/fhir/DSTU2/http.html#search), STU3 (http://hl7.org/implement/standards/fhir/STU3/http.html#search), R4 (http://hl7.org/implement/standards/fhir/R4/http.html#search)) using the search semantics described in the FHIR Search specification (DSTU2 (http://hl7.org/implement/standards/fhir/DSTU2/search.html), STU3 (http://hl7.org/implement/standards/fhir/STU3/search.html), R4 (http://hl7.org/implement/standards/fhir/R4/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry (STU3 (http://hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html), R4 (http://hl7.org/implement/standards/fhir/R4/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned `Bundle` contains a link of `relation` "next", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any of the following search result parameters can be used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn't optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the default sorting order. Note: The special synchronous identifier index are currently disabled for DocumentReference and DocumentManifest searches. For samples and detailed information, see Searching for FHIR resources (https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and Advanced FHIR search features (https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).

- parent: Name of the FHIR store to retrieve resources from.

func (*ProjectsLocationsDatasetsFhirStoresFhirService) SearchType added in v0.38.0

SearchType: Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction (DSTU2 (http://hl7.org/implement/standards/fhir/DSTU2/http.html#search), STU3 (http://hl7.org/implement/standards/fhir/STU3/http.html#search), R4 (http://hl7.org/implement/standards/fhir/R4/http.html#search)) using the search semantics described in the FHIR Search specification (DSTU2 (http://hl7.org/implement/standards/fhir/DSTU2/search.html), STU3 (http://hl7.org/implement/standards/fhir/STU3/search.html), R4 (http://hl7.org/implement/standards/fhir/R4/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry (STU3 (http://hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html), R4 (http://hl7.org/implement/standards/fhir/R4/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned `Bundle` contains a link of `relation` "next", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any of the following search result parameters can be used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn't optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the default sorting order. Note: The special synchronous identifier index are currently disabled for DocumentReference and DocumentManifest searches. For samples and detailed information, see Searching for FHIR resources (https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and Advanced FHIR search features (https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).

func (*ProjectsLocationsDatasetsFhirStoresFhirService) Update

Update: Updates the entire contents of a resource. Implements the FHIR standard update interaction (DSTU2 (http://hl7.org/implement/standards/fhir/DSTU2/http.html#update), STU3 (http://hl7.org/implement/standards/fhir/STU3/http.html#update), R4 (http://hl7.org/implement/standards/fhir/R4/http.html#update)). If the specified resource does not exist and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. 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. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. The resource must contain an `id` element having an identical value to the ID in the REST path of the request. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `update`, see Updating a FHIR resource (https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#updating_a_fhir_resource).

- name: The name of the resource to update.

func (*ProjectsLocationsDatasetsFhirStoresFhirService) Vread

Vread: Gets the contents of a version (current or historical) of a FHIR resource by version ID. Implements the FHIR standard vread interaction (DSTU2 (http://hl7.org/implement/standards/fhir/DSTU2/http.html#vread), STU3 (http://hl7.org/implement/standards/fhir/STU3/http.html#vread), R4 (http://hl7.org/implement/standards/fhir/R4/http.html#vread)). On success, the response body contains a JSON-encoded representation of the resource. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `vread`, see Retrieving a FHIR resource version (https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#retrieving_a_fhir_resource_version).

- name: The name of the resource version to retrieve.

type ProjectsLocationsDatasetsFhirStoresFhirUpdateCall

type ProjectsLocationsDatasetsFhirStoresFhirUpdateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsFhirStoresFhirUpdateCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsFhirStoresFhirUpdateCall) Do

Do executes the "healthcare.projects.locations.datasets.fhirStores.fhir.update" call.

func (*ProjectsLocationsDatasetsFhirStoresFhirUpdateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsFhirStoresFhirUpdateCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDatasetsFhirStoresFhirVreadCall

type ProjectsLocationsDatasetsFhirStoresFhirVreadCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsFhirStoresFhirVreadCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsFhirStoresFhirVreadCall) Do

Do executes the "healthcare.projects.locations.datasets.fhirStores.fhir.vread" call.

func (*ProjectsLocationsDatasetsFhirStoresFhirVreadCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsFhirStoresFhirVreadCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDatasetsFhirStoresFhirVreadCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsDatasetsFhirStoresGetCall

type ProjectsLocationsDatasetsFhirStoresGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsFhirStoresGetCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsFhirStoresGetCall) Do

Do executes the "healthcare.projects.locations.datasets.fhirStores.get" call. Any non-2xx status code is an error. Response headers are in either *FhirStore.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsFhirStoresGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsFhirStoresGetCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDatasetsFhirStoresGetCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsDatasetsFhirStoresGetFHIRStoreMetricsCall added in v0.111.0

type ProjectsLocationsDatasetsFhirStoresGetFHIRStoreMetricsCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsFhirStoresGetFHIRStoreMetricsCall) Context added in v0.111.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsFhirStoresGetFHIRStoreMetricsCall) Do added in v0.111.0

Do executes the "healthcare.projects.locations.datasets.fhirStores.getFHIRStoreMetrics" call. Any non-2xx status code is an error. Response headers are in either *FhirStoreMetrics.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsFhirStoresGetFHIRStoreMetricsCall) Fields added in v0.111.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsFhirStoresGetFHIRStoreMetricsCall) Header added in v0.111.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDatasetsFhirStoresGetFHIRStoreMetricsCall) IfNoneMatch added in v0.111.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsDatasetsFhirStoresGetIamPolicyCall

type ProjectsLocationsDatasetsFhirStoresGetIamPolicyCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsFhirStoresGetIamPolicyCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsFhirStoresGetIamPolicyCall) Do

Do executes the "healthcare.projects.locations.datasets.fhirStores.getIamPolicy" call. Any non-2xx status code is an error. Response headers are in either *Policy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsFhirStoresGetIamPolicyCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsFhirStoresGetIamPolicyCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDatasetsFhirStoresGetIamPolicyCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsDatasetsFhirStoresGetIamPolicyCall) OptionsRequestedPolicyVersion

func (c *ProjectsLocationsDatasetsFhirStoresGetIamPolicyCall) OptionsRequestedPolicyVersion(optionsRequestedPolicyVersion int64) *ProjectsLocationsDatasetsFhirStoresGetIamPolicyCall

OptionsRequestedPolicyVersion sets the optional parameter "options.requestedPolicyVersion": The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).

type ProjectsLocationsDatasetsFhirStoresImportCall

type ProjectsLocationsDatasetsFhirStoresImportCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsFhirStoresImportCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsFhirStoresImportCall) Do

Do executes the "healthcare.projects.locations.datasets.fhirStores.import" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsFhirStoresImportCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsFhirStoresImportCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDatasetsFhirStoresListCall

type ProjectsLocationsDatasetsFhirStoresListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsFhirStoresListCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsFhirStoresListCall) Do

Do executes the "healthcare.projects.locations.datasets.fhirStores.list" call. Any non-2xx status code is an error. Response headers are in either *ListFhirStoresResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsFhirStoresListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsFhirStoresListCall) Filter

Filter sets the optional parameter "filter": Restricts stores returned to those matching a filter. The following syntax is available: * A string field value can be written as text inside quotation marks, for example "query text". The only valid relational operation for text fields is equality (`=`), where text is searched within the field, rather than having the field be equal to the text. For example, "Comment = great" returns messages with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. Only filtering on labels is supported, for example `labels.key=value`.

func (*ProjectsLocationsDatasetsFhirStoresListCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDatasetsFhirStoresListCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsDatasetsFhirStoresListCall) PageSize

PageSize sets the optional parameter "pageSize": Limit on the number of FHIR stores to return in a single response. If not specified, 100 is used. May not be larger than 1000.

func (*ProjectsLocationsDatasetsFhirStoresListCall) PageToken

PageToken sets the optional parameter "pageToken": The next_page_token value returned from the previous List request, if any.

func (*ProjectsLocationsDatasetsFhirStoresListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsDatasetsFhirStoresPatchCall

type ProjectsLocationsDatasetsFhirStoresPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsFhirStoresPatchCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsFhirStoresPatchCall) Do

Do executes the "healthcare.projects.locations.datasets.fhirStores.patch" call. Any non-2xx status code is an error. Response headers are in either *FhirStore.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsFhirStoresPatchCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsFhirStoresPatchCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDatasetsFhirStoresPatchCall) UpdateMask

UpdateMask sets the optional parameter "updateMask": Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask

type ProjectsLocationsDatasetsFhirStoresRollbackCall added in v0.158.0

type ProjectsLocationsDatasetsFhirStoresRollbackCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsFhirStoresRollbackCall) Context added in v0.158.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsFhirStoresRollbackCall) Do added in v0.158.0

Do executes the "healthcare.projects.locations.datasets.fhirStores.rollback" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsFhirStoresRollbackCall) Fields added in v0.158.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsFhirStoresRollbackCall) Header added in v0.158.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDatasetsFhirStoresService

type ProjectsLocationsDatasetsFhirStoresService struct {
	Fhir *ProjectsLocationsDatasetsFhirStoresFhirService
	// contains filtered or unexported fields
}

func NewProjectsLocationsDatasetsFhirStoresService

func NewProjectsLocationsDatasetsFhirStoresService(s *Service) *ProjectsLocationsDatasetsFhirStoresService

func (*ProjectsLocationsDatasetsFhirStoresService) Create

Create: Creates a new FHIR store within the parent dataset.

- parent: The name of the dataset this FHIR store belongs to.

func (*ProjectsLocationsDatasetsFhirStoresService) Deidentify

Deidentify: De-identifies data from the source store and writes it to the destination store. The metadata field type is OperationMetadata. If the request is successful, the response field type is DeidentifyFhirStoreSummary. If errors occur, error is set. Error details are also logged to Cloud Logging (see Viewing error logs in Cloud Logging (https://cloud.google.com/healthcare/docs/how-tos/logging)).

  • sourceStore: Source FHIR store resource name. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirSt ores/{fhir_store_id}`.

func (*ProjectsLocationsDatasetsFhirStoresService) Delete

Delete: Deletes the specified FHIR store and removes all resources within it.

- name: The resource name of the FHIR store to delete.

func (*ProjectsLocationsDatasetsFhirStoresService) Export

Export: Export resources from the FHIR store to the specified destination. This method returns an Operation that can be used to track the status of the export by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see Viewing error logs in Cloud Logging (https://cloud.google.com/healthcare/docs/how-tos/logging)). Otherwise, when the operation finishes, a detailed response of type ExportResourcesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata.

  • name: The name of the FHIR store to export resource from, in the format of `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirSt ores/{fhir_store_id}`.

func (*ProjectsLocationsDatasetsFhirStoresService) Get

Get: Gets the configuration of the specified FHIR store.

- name: The resource name of the FHIR store to get.

func (*ProjectsLocationsDatasetsFhirStoresService) GetFHIRStoreMetrics added in v0.111.0

GetFHIRStoreMetrics: Gets metrics associated with the FHIR store.

- name: The resource name of the FHIR store to get metrics for.

func (*ProjectsLocationsDatasetsFhirStoresService) GetIamPolicy

GetIamPolicy: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

func (*ProjectsLocationsDatasetsFhirStoresService) Import

Import: Imports resources to the FHIR store by loading data from the specified sources. This method is optimized to load large quantities of data using import semantics that ignore some FHIR store configuration options and are not suitable for all use cases. It is primarily intended to load data into an empty FHIR store that is not being used by other clients. In cases where this method is not appropriate, consider using ExecuteBundle to load data. Every resource in the input must contain a client-supplied ID. Each resource is stored using the supplied ID regardless of the enable_update_create setting on the FHIR store. 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 Cloud Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. The import process does not enforce referential integrity, regardless of the disable_referential_integrity setting on the FHIR store. This allows the import of resources with arbitrary interdependencies without considering grouping or ordering, but if the input data contains invalid references or if some resources fail to be imported, the FHIR store might be left in a state that violates referential integrity. The import process does not trigger Pub/Sub notification or BigQuery streaming update, regardless of how those are configured on the FHIR store. If a resource with the specified ID already exists, the most recent version of the resource is overwritten without creating a new historical version, regardless of the disable_resource_versioning setting on the FHIR store. If transient failures occur during the import, it's possible that successfully imported resources will be overwritten more than once. The import operation is idempotent unless the input data contains multiple valid resources with the same ID but different contents. In that case, after the import completes, the store contains exactly one resource with that ID but there is no ordering guarantee on which version of the contents it will have. The operation result counters do not count duplicate IDs as an error and count one success for each resource in the input, which might result in a success count larger than the number of resources in the FHIR store. This often occurs when importing data organized in bundles produced by Patient-everything where each bundle contains its own copy of a resource such as Practitioner that might be referred to by many patients. If some resources fail to import, for example due to parsing errors, successfully imported resources are not rolled back. The location and format of the input data is specified by the parameters in ImportResourcesRequest. Note that if no format is specified, this method assumes the `BUNDLE` format. When using the `BUNDLE` format this method ignores the `Bundle.type` field, except that `history` bundles are rejected, and does not apply any of the bundle processing semantics for batch or transaction bundles. Unlike in ExecuteBundle, transaction bundles are not executed as a single transaction and bundle-internal references are not rewritten. The bundle is treated as a collection of resources to be written as provided in `Bundle.entry.resource`, ignoring `Bundle.entry.request`. As an example, this allows the import of `searchset` bundles produced by a FHIR search or Patient-everything operation. This method returns an Operation that can be used to track the status of the import by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see Viewing error logs in Cloud Logging (https://cloud.google.com/healthcare/docs/how-tos/logging)). Otherwise, when the operation finishes, a detailed response of type ImportResourcesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata.

  • name: The name of the FHIR store to import FHIR resources to, in the format of `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirSt ores/{fhir_store_id}`.

func (*ProjectsLocationsDatasetsFhirStoresService) List

List: Lists the FHIR stores in the given dataset.

- parent: Name of the dataset.

func (*ProjectsLocationsDatasetsFhirStoresService) Patch

Patch: Updates the configuration of the specified FHIR store.

  • name: Output only. Identifier. Resource name of the FHIR store, of the form `projects/{project_id}/locations/{location}/datasets/{dataset_id}/fhirStore s/{fhir_store_id}`.

func (*ProjectsLocationsDatasetsFhirStoresService) Rollback added in v0.158.0

Rollback: Rolls back resources from the FHIR store to the specified time. This method returns an Operation that can be used to track the status of the rollback by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see Viewing error logs in Cloud Logging (https://cloud.google.com/healthcare/docs/how-tos/logging)). Otherwise, when the operation finishes, a detailed response of type RollbackFhirResourcesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata.

  • name: The name of the FHIR store to rollback, in the format of "projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /fhirStores/{fhir_store_id}".

func (*ProjectsLocationsDatasetsFhirStoresService) SetIamPolicy

SetIamPolicy: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

func (*ProjectsLocationsDatasetsFhirStoresService) TestIamPermissions

TestIamPermissions: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

type ProjectsLocationsDatasetsFhirStoresSetIamPolicyCall

type ProjectsLocationsDatasetsFhirStoresSetIamPolicyCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsFhirStoresSetIamPolicyCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsFhirStoresSetIamPolicyCall) Do

Do executes the "healthcare.projects.locations.datasets.fhirStores.setIamPolicy" call. Any non-2xx status code is an error. Response headers are in either *Policy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsFhirStoresSetIamPolicyCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsFhirStoresSetIamPolicyCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDatasetsFhirStoresTestIamPermissionsCall

type ProjectsLocationsDatasetsFhirStoresTestIamPermissionsCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsFhirStoresTestIamPermissionsCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsFhirStoresTestIamPermissionsCall) Do

Do executes the "healthcare.projects.locations.datasets.fhirStores.testIamPermissions" call. Any non-2xx status code is an error. Response headers are in either *TestIamPermissionsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsFhirStoresTestIamPermissionsCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsFhirStoresTestIamPermissionsCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDatasetsGetCall

type ProjectsLocationsDatasetsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsGetCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsGetCall) Do

Do executes the "healthcare.projects.locations.datasets.get" call. Any non-2xx status code is an error. Response headers are in either *Dataset.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsGetCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDatasetsGetCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsDatasetsGetIamPolicyCall

type ProjectsLocationsDatasetsGetIamPolicyCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsGetIamPolicyCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsGetIamPolicyCall) Do

Do executes the "healthcare.projects.locations.datasets.getIamPolicy" call. Any non-2xx status code is an error. Response headers are in either *Policy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsGetIamPolicyCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsGetIamPolicyCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDatasetsGetIamPolicyCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsDatasetsGetIamPolicyCall) OptionsRequestedPolicyVersion

func (c *ProjectsLocationsDatasetsGetIamPolicyCall) OptionsRequestedPolicyVersion(optionsRequestedPolicyVersion int64) *ProjectsLocationsDatasetsGetIamPolicyCall

OptionsRequestedPolicyVersion sets the optional parameter "options.requestedPolicyVersion": The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).

type ProjectsLocationsDatasetsHl7V2StoresCreateCall

type ProjectsLocationsDatasetsHl7V2StoresCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsHl7V2StoresCreateCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsHl7V2StoresCreateCall) Do

Do executes the "healthcare.projects.locations.datasets.hl7V2Stores.create" call. Any non-2xx status code is an error. Response headers are in either *Hl7V2Store.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsHl7V2StoresCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsHl7V2StoresCreateCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDatasetsHl7V2StoresCreateCall) Hl7V2StoreId

Hl7V2StoreId sets the optional parameter "hl7V2StoreId": Required. The ID of the HL7v2 store that is being created. The string must match the following regex: `[\p{L}\p{N}_\-\.]{1,256}`.

type ProjectsLocationsDatasetsHl7V2StoresDeleteCall

type ProjectsLocationsDatasetsHl7V2StoresDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsHl7V2StoresDeleteCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsHl7V2StoresDeleteCall) Do

Do executes the "healthcare.projects.locations.datasets.hl7V2Stores.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsHl7V2StoresDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsHl7V2StoresDeleteCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDatasetsHl7V2StoresExportCall added in v0.59.0

type ProjectsLocationsDatasetsHl7V2StoresExportCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsHl7V2StoresExportCall) Context added in v0.59.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsHl7V2StoresExportCall) Do added in v0.59.0

Do executes the "healthcare.projects.locations.datasets.hl7V2Stores.export" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsHl7V2StoresExportCall) Fields added in v0.59.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsHl7V2StoresExportCall) Header added in v0.59.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDatasetsHl7V2StoresGetCall

type ProjectsLocationsDatasetsHl7V2StoresGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsHl7V2StoresGetCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsHl7V2StoresGetCall) Do

Do executes the "healthcare.projects.locations.datasets.hl7V2Stores.get" call. Any non-2xx status code is an error. Response headers are in either *Hl7V2Store.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsHl7V2StoresGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsHl7V2StoresGetCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDatasetsHl7V2StoresGetCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsDatasetsHl7V2StoresGetHL7v2StoreMetricsCall added in v0.147.0

type ProjectsLocationsDatasetsHl7V2StoresGetHL7v2StoreMetricsCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsHl7V2StoresGetHL7v2StoreMetricsCall) Context added in v0.147.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsHl7V2StoresGetHL7v2StoreMetricsCall) Do added in v0.147.0

Do executes the "healthcare.projects.locations.datasets.hl7V2Stores.getHL7v2StoreMetrics" call. Any non-2xx status code is an error. Response headers are in either *Hl7V2StoreMetrics.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsHl7V2StoresGetHL7v2StoreMetricsCall) Fields added in v0.147.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsHl7V2StoresGetHL7v2StoreMetricsCall) Header added in v0.147.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDatasetsHl7V2StoresGetHL7v2StoreMetricsCall) IfNoneMatch added in v0.147.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsDatasetsHl7V2StoresGetIamPolicyCall

type ProjectsLocationsDatasetsHl7V2StoresGetIamPolicyCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsHl7V2StoresGetIamPolicyCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsHl7V2StoresGetIamPolicyCall) Do

Do executes the "healthcare.projects.locations.datasets.hl7V2Stores.getIamPolicy" call. Any non-2xx status code is an error. Response headers are in either *Policy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsHl7V2StoresGetIamPolicyCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsHl7V2StoresGetIamPolicyCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDatasetsHl7V2StoresGetIamPolicyCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsDatasetsHl7V2StoresGetIamPolicyCall) OptionsRequestedPolicyVersion

func (c *ProjectsLocationsDatasetsHl7V2StoresGetIamPolicyCall) OptionsRequestedPolicyVersion(optionsRequestedPolicyVersion int64) *ProjectsLocationsDatasetsHl7V2StoresGetIamPolicyCall

OptionsRequestedPolicyVersion sets the optional parameter "options.requestedPolicyVersion": The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).

type ProjectsLocationsDatasetsHl7V2StoresImportCall added in v0.59.0

type ProjectsLocationsDatasetsHl7V2StoresImportCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsHl7V2StoresImportCall) Context added in v0.59.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsHl7V2StoresImportCall) Do added in v0.59.0

Do executes the "healthcare.projects.locations.datasets.hl7V2Stores.import" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsHl7V2StoresImportCall) Fields added in v0.59.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsHl7V2StoresImportCall) Header added in v0.59.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDatasetsHl7V2StoresListCall

type ProjectsLocationsDatasetsHl7V2StoresListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsHl7V2StoresListCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsHl7V2StoresListCall) Do

Do executes the "healthcare.projects.locations.datasets.hl7V2Stores.list" call. Any non-2xx status code is an error. Response headers are in either *ListHl7V2StoresResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsHl7V2StoresListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsHl7V2StoresListCall) Filter

Filter sets the optional parameter "filter": Restricts stores returned to those matching a filter. The following syntax is available: * A string field value can be written as text inside quotation marks, for example "query text". The only valid relational operation for text fields is equality (`=`), where text is searched within the field, rather than having the field be equal to the text. For example, "Comment = great" returns messages with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. Only filtering on labels is supported. For example, `labels.key=value`.

func (*ProjectsLocationsDatasetsHl7V2StoresListCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDatasetsHl7V2StoresListCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsDatasetsHl7V2StoresListCall) PageSize

PageSize sets the optional parameter "pageSize": Limit on the number of HL7v2 stores to return in a single response. If not specified, 100 is used. May not be larger than 1000.

func (*ProjectsLocationsDatasetsHl7V2StoresListCall) PageToken

PageToken sets the optional parameter "pageToken": The next_page_token value returned from the previous List request, if any.

func (*ProjectsLocationsDatasetsHl7V2StoresListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsDatasetsHl7V2StoresMessagesCreateCall

type ProjectsLocationsDatasetsHl7V2StoresMessagesCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesCreateCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesCreateCall) Do

Do executes the "healthcare.projects.locations.datasets.hl7V2Stores.messages.create" call. Any non-2xx status code is an error. Response headers are in either *Message.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesCreateCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDatasetsHl7V2StoresMessagesDeleteCall

type ProjectsLocationsDatasetsHl7V2StoresMessagesDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesDeleteCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesDeleteCall) Do

Do executes the "healthcare.projects.locations.datasets.hl7V2Stores.messages.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesDeleteCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDatasetsHl7V2StoresMessagesGetCall

type ProjectsLocationsDatasetsHl7V2StoresMessagesGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesGetCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesGetCall) Do

Do executes the "healthcare.projects.locations.datasets.hl7V2Stores.messages.get" call. Any non-2xx status code is an error. Response headers are in either *Message.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesGetCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesGetCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesGetCall) View

View sets the optional parameter "view": Specifies which parts of the Message resource to return in the response. When unspecified, equivalent to FULL.

Possible values:

"MESSAGE_VIEW_UNSPECIFIED" - Not specified, equivalent to FULL.
"RAW_ONLY" - Server responses include all the message fields except

parsed_data field, and schematized_data fields.

"PARSED_ONLY" - Server responses include all the message fields except

data field, and schematized_data fields.

"FULL" - Server responses include all the message fields.
"SCHEMATIZED_ONLY" - Server responses include all the message fields

except data and parsed_data fields.

"BASIC" - Server responses include only the name field.

type ProjectsLocationsDatasetsHl7V2StoresMessagesIngestCall

type ProjectsLocationsDatasetsHl7V2StoresMessagesIngestCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesIngestCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesIngestCall) Do

Do executes the "healthcare.projects.locations.datasets.hl7V2Stores.messages.ingest" call. Any non-2xx status code is an error. Response headers are in either *IngestMessageResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesIngestCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesIngestCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDatasetsHl7V2StoresMessagesListCall

type ProjectsLocationsDatasetsHl7V2StoresMessagesListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesListCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesListCall) Do

Do executes the "healthcare.projects.locations.datasets.hl7V2Stores.messages.list" call. Any non-2xx status code is an error. Response headers are in either *ListMessagesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesListCall) Filter

Filter sets the optional parameter "filter": Restricts messages returned to those matching a filter. The following syntax is available: * A string field value can be written as text inside quotation marks, for example "query text". The only valid relational operation for text fields is equality (`=`), where text is searched within the field, rather than having the field be equal to the text. For example, "Comment = great" returns messages with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. Fields/functions available for filtering are: * `message_type`, from the MSH-9.1 field. For example, `NOT message_type = "ADT". * `send_date` or `sendDate`, the YYYY-MM-DD date the message was sent in the dataset's time_zone, from the MSH-7 segment. For example, `send_date < "2017-01-02". * `send_time`, the timestamp when the message was sent, using the RFC3339 time format for comparisons, from the MSH-7 segment. For example, `send_time < "2017-01-02T00:00:00-05:00". * `create_time`, the timestamp when the message was created in the HL7v2 store. Use the RFC3339 time format for comparisons. For example, `create_time < "2017-01-02T00:00:00-05:00". * `send_facility`, the care center that the message came from, from the MSH-4 segment. For example, `send_facility = "ABC". * `PatientId(value, type)`, which matches if the message lists a patient having an ID of the given value and type in the PID-2, PID-3, or PID-4 segments. For example, `PatientId("123456", "MRN")`. * `labels.x`, a string value of the label with key `x` as set using the Message.labels map. For example, `labels."priority"="high". The operator `:*` can be used to assert the existence of a label. For example, `labels."priority":*`.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesListCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesListCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesListCall) OrderBy

OrderBy sets the optional parameter "orderBy": Orders messages returned by the specified order_by clause. Syntax: https://cloud.google.com/apis/design/design_patterns#sorting_order Fields available for ordering are: * `send_time`

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesListCall) PageSize

PageSize sets the optional parameter "pageSize": Limit on the number of messages to return in a single response. If not specified, 100 is used. May not be larger than 1000.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesListCall) PageToken

PageToken sets the optional parameter "pageToken": The next_page_token value returned from the previous List request, if any.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesListCall) View

View sets the optional parameter "view": Specifies the parts of the Message to return in the response. When unspecified, equivalent to BASIC. Setting this to anything other than BASIC with a `page_size` larger than the default can generate a large response, which impacts the performance of this method.

Possible values:

"MESSAGE_VIEW_UNSPECIFIED" - Not specified, equivalent to FULL.
"RAW_ONLY" - Server responses include all the message fields except

parsed_data field, and schematized_data fields.

"PARSED_ONLY" - Server responses include all the message fields except

data field, and schematized_data fields.

"FULL" - Server responses include all the message fields.
"SCHEMATIZED_ONLY" - Server responses include all the message fields

except data and parsed_data fields.

"BASIC" - Server responses include only the name field.

type ProjectsLocationsDatasetsHl7V2StoresMessagesPatchCall

type ProjectsLocationsDatasetsHl7V2StoresMessagesPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesPatchCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesPatchCall) Do

Do executes the "healthcare.projects.locations.datasets.hl7V2Stores.messages.patch" call. Any non-2xx status code is an error. Response headers are in either *Message.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesPatchCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesPatchCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesPatchCall) UpdateMask

UpdateMask sets the optional parameter "updateMask": Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask

type ProjectsLocationsDatasetsHl7V2StoresMessagesService

type ProjectsLocationsDatasetsHl7V2StoresMessagesService struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesService) Create

Create: Parses and stores an HL7v2 message. This method triggers an asynchronous notification to any Pub/Sub topic configured in Hl7V2Store.Hl7V2NotificationConfig, if the filtering matches the message. If an MLLP adapter is configured to listen to a Pub/Sub topic, the adapter transmits the message when a notification is received.

- parent: The name of the HL7v2 store this message belongs to.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesService) Delete

Delete: Deletes an HL7v2 message.

- name: The resource name of the HL7v2 message to delete.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesService) Get

Get: Gets an HL7v2 message.

- name: The resource name of the HL7v2 message to retrieve.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesService) Ingest

Ingest: Parses and stores an HL7v2 message. This method triggers an asynchronous notification to any Pub/Sub topic configured in Hl7V2Store.Hl7V2NotificationConfig, if the filtering matches the message. If an MLLP adapter is configured to listen to a Pub/Sub topic, the adapter transmits the message when a notification is received. If the method is successful, it generates a response containing an HL7v2 acknowledgment (`ACK`) message. If the method encounters an error, it returns a negative acknowledgment (`NACK`) message. This behavior is suitable for replying to HL7v2 interface systems that expect these acknowledgments.

- parent: The name of the HL7v2 store this message belongs to.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesService) List

List: Lists all the messages in the given HL7v2 store with support for filtering. Note: HL7v2 messages are indexed asynchronously, so there might be a slight delay between the time a message is created and when it can be found through a filter.

- parent: Name of the HL7v2 store to retrieve messages from.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesService) Patch

Patch: Update the message. The contents of the message in Message.data and data extracted from the contents such as Message.create_time cannot be altered. Only the Message.labels field is allowed to be updated. The labels in the request are merged with the existing set of labels. Existing labels with the same keys are updated.

  • name: Output only. Resource name of the Message, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2S tores/{hl7_v2_store_id}/messages/{message_id}`.

type ProjectsLocationsDatasetsHl7V2StoresPatchCall

type ProjectsLocationsDatasetsHl7V2StoresPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsHl7V2StoresPatchCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsHl7V2StoresPatchCall) Do

Do executes the "healthcare.projects.locations.datasets.hl7V2Stores.patch" call. Any non-2xx status code is an error. Response headers are in either *Hl7V2Store.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsHl7V2StoresPatchCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsHl7V2StoresPatchCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDatasetsHl7V2StoresPatchCall) UpdateMask

UpdateMask sets the optional parameter "updateMask": Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask

type ProjectsLocationsDatasetsHl7V2StoresRollbackCall added in v0.191.0

type ProjectsLocationsDatasetsHl7V2StoresRollbackCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsHl7V2StoresRollbackCall) Context added in v0.191.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsHl7V2StoresRollbackCall) Do added in v0.191.0

Do executes the "healthcare.projects.locations.datasets.hl7V2Stores.rollback" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsHl7V2StoresRollbackCall) Fields added in v0.191.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsHl7V2StoresRollbackCall) Header added in v0.191.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDatasetsHl7V2StoresService

type ProjectsLocationsDatasetsHl7V2StoresService struct {
	Messages *ProjectsLocationsDatasetsHl7V2StoresMessagesService
	// contains filtered or unexported fields
}

func NewProjectsLocationsDatasetsHl7V2StoresService

func NewProjectsLocationsDatasetsHl7V2StoresService(s *Service) *ProjectsLocationsDatasetsHl7V2StoresService

func (*ProjectsLocationsDatasetsHl7V2StoresService) Create

Create: Creates a new HL7v2 store within the parent dataset.

- parent: The name of the dataset this HL7v2 store belongs to.

func (*ProjectsLocationsDatasetsHl7V2StoresService) Delete

Delete: Deletes the specified HL7v2 store and removes all messages that it contains.

- name: The resource name of the HL7v2 store to delete.

func (*ProjectsLocationsDatasetsHl7V2StoresService) Export added in v0.59.0

Export: Exports the messages to a destination. To filter messages to be exported, define a filter using the start and end time, relative to the message generation time (MSH.7). This API returns an Operation that can be used to track the status of the job by calling GetOperation. Immediate fatal errors appear in the error field. Otherwise, when the operation finishes, a detailed response of type ExportMessagesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata.

  • name: The name of the source HL7v2 store, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7v2S tores/{hl7v2_store_id}`.

func (*ProjectsLocationsDatasetsHl7V2StoresService) Get

Get: Gets the specified HL7v2 store.

- name: The resource name of the HL7v2 store to get.

func (*ProjectsLocationsDatasetsHl7V2StoresService) GetHL7v2StoreMetrics added in v0.147.0

GetHL7v2StoreMetrics: Gets metrics associated with the HL7v2 store.

  • name: The resource name of the HL7v2 store to get metrics for, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2S tores/{hl7v2_store_id}`.

func (*ProjectsLocationsDatasetsHl7V2StoresService) GetIamPolicy

GetIamPolicy: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

func (*ProjectsLocationsDatasetsHl7V2StoresService) Import added in v0.59.0

Import: Import messages to the HL7v2 store by loading data from the specified sources. This method is optimized to load large quantities of data using import semantics that ignore some HL7v2 store configuration options and are not suitable for all use cases. It is primarily intended to load data into an empty HL7v2 store that is not being used by other clients. An existing message will be overwritten if a duplicate message is imported. A duplicate message is a message with the same raw bytes as a message that already exists in this HL7v2 store. When a message is overwritten, its labels will also be overwritten. The import operation is idempotent unless the input data contains multiple valid messages with the same raw bytes but different labels. In that case, after the import completes, the store contains exactly one message with those raw bytes but there is no ordering guarantee on which version of the labels it has. The operation result counters do not count duplicated raw bytes as an error and count one success for each message in the input, which might result in a success count larger than the number of messages in the HL7v2 store. If some messages fail to import, for example due to parsing errors, successfully imported messages are not rolled back. This method returns an Operation that can be used to track the status of the import by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see Viewing error logs in Cloud Logging (https://cloud.google.com/healthcare/docs/how-tos/logging)). Otherwise, when the operation finishes, a response of type ImportMessagesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata.

  • name: The name of the target HL7v2 store, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7v2S tores/{hl7v2_store_id}`.

func (*ProjectsLocationsDatasetsHl7V2StoresService) List

List: Lists the HL7v2 stores in the given dataset.

- parent: Name of the dataset.

func (*ProjectsLocationsDatasetsHl7V2StoresService) Patch

Patch: Updates the HL7v2 store.

  • name: Identifier. Resource name of the HL7v2 store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2S tores/{hl7v2_store_id}`.

func (*ProjectsLocationsDatasetsHl7V2StoresService) Rollback added in v0.191.0

Rollback: Rolls back messages from the HL7 store to the specified time. This method returns an Operation that can be used to track the status of the rollback by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see Viewing error logs in Cloud Logging (https://cloud.google.com/healthcare/docs/how-tos/logging)). Otherwise, when the operation finishes, a detailed response of type RollbackHl7V2MessagesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata.

  • name: The name of the HL7v2 store to rollback, in the format of "projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /hl7V2Stores/{hl7v2_store_id}".

func (*ProjectsLocationsDatasetsHl7V2StoresService) SetIamPolicy

SetIamPolicy: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

func (*ProjectsLocationsDatasetsHl7V2StoresService) TestIamPermissions

TestIamPermissions: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

type ProjectsLocationsDatasetsHl7V2StoresSetIamPolicyCall

type ProjectsLocationsDatasetsHl7V2StoresSetIamPolicyCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsHl7V2StoresSetIamPolicyCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsHl7V2StoresSetIamPolicyCall) Do

Do executes the "healthcare.projects.locations.datasets.hl7V2Stores.setIamPolicy" call. Any non-2xx status code is an error. Response headers are in either *Policy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsHl7V2StoresSetIamPolicyCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsHl7V2StoresSetIamPolicyCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDatasetsHl7V2StoresTestIamPermissionsCall

type ProjectsLocationsDatasetsHl7V2StoresTestIamPermissionsCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsHl7V2StoresTestIamPermissionsCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsHl7V2StoresTestIamPermissionsCall) Do

Do executes the "healthcare.projects.locations.datasets.hl7V2Stores.testIamPermissions" call. Any non-2xx status code is an error. Response headers are in either *TestIamPermissionsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsHl7V2StoresTestIamPermissionsCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsHl7V2StoresTestIamPermissionsCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDatasetsListCall

type ProjectsLocationsDatasetsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsListCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsListCall) Do

Do executes the "healthcare.projects.locations.datasets.list" call. Any non-2xx status code is an error. Response headers are in either *ListDatasetsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsListCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDatasetsListCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsDatasetsListCall) PageSize

PageSize sets the optional parameter "pageSize": The maximum number of items to return. If not specified, 100 is used. May not be larger than 1000.

func (*ProjectsLocationsDatasetsListCall) PageToken

PageToken sets the optional parameter "pageToken": The next_page_token value returned from a previous List request, if any.

func (*ProjectsLocationsDatasetsListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsDatasetsOperationsCancelCall

type ProjectsLocationsDatasetsOperationsCancelCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsOperationsCancelCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsOperationsCancelCall) Do

Do executes the "healthcare.projects.locations.datasets.operations.cancel" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsOperationsCancelCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsOperationsCancelCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDatasetsOperationsGetCall

type ProjectsLocationsDatasetsOperationsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsOperationsGetCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsOperationsGetCall) Do

Do executes the "healthcare.projects.locations.datasets.operations.get" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsOperationsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsOperationsGetCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDatasetsOperationsGetCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsDatasetsOperationsListCall

type ProjectsLocationsDatasetsOperationsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsOperationsListCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsOperationsListCall) Do

Do executes the "healthcare.projects.locations.datasets.operations.list" call. Any non-2xx status code is an error. Response headers are in either *ListOperationsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsOperationsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsOperationsListCall) Filter

Filter sets the optional parameter "filter": The standard list filter.

func (*ProjectsLocationsDatasetsOperationsListCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDatasetsOperationsListCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsDatasetsOperationsListCall) PageSize

PageSize sets the optional parameter "pageSize": The standard list page size.

func (*ProjectsLocationsDatasetsOperationsListCall) PageToken

PageToken sets the optional parameter "pageToken": The standard list page token.

func (*ProjectsLocationsDatasetsOperationsListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsDatasetsOperationsService

type ProjectsLocationsDatasetsOperationsService struct {
	// contains filtered or unexported fields
}

func NewProjectsLocationsDatasetsOperationsService

func NewProjectsLocationsDatasetsOperationsService(s *Service) *ProjectsLocationsDatasetsOperationsService

func (*ProjectsLocationsDatasetsOperationsService) Cancel

Cancel: Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.

- name: The name of the operation resource to be cancelled.

func (*ProjectsLocationsDatasetsOperationsService) Get

Get: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- name: The name of the operation resource.

func (*ProjectsLocationsDatasetsOperationsService) List

List: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

- name: The name of the operation's parent resource.

type ProjectsLocationsDatasetsPatchCall

type ProjectsLocationsDatasetsPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsPatchCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsPatchCall) Do

Do executes the "healthcare.projects.locations.datasets.patch" call. Any non-2xx status code is an error. Response headers are in either *Dataset.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsPatchCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsPatchCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDatasetsPatchCall) UpdateMask

UpdateMask sets the optional parameter "updateMask": Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask

type ProjectsLocationsDatasetsService

type ProjectsLocationsDatasetsService struct {
	ConsentStores *ProjectsLocationsDatasetsConsentStoresService

	DataMapperWorkspaces *ProjectsLocationsDatasetsDataMapperWorkspacesService

	DicomStores *ProjectsLocationsDatasetsDicomStoresService

	FhirStores *ProjectsLocationsDatasetsFhirStoresService

	Hl7V2Stores *ProjectsLocationsDatasetsHl7V2StoresService

	Operations *ProjectsLocationsDatasetsOperationsService
	// contains filtered or unexported fields
}

func NewProjectsLocationsDatasetsService

func NewProjectsLocationsDatasetsService(s *Service) *ProjectsLocationsDatasetsService

func (*ProjectsLocationsDatasetsService) Create

Create: Creates a new health dataset. Results are returned through the Operation interface which returns either an `Operation.response` which contains a Dataset or `Operation.error`. The metadata field type is OperationMetadata.

  • parent: The name of the project where the server creates the dataset. For example, `projects/{project_id}/locations/{location_id}`.

func (*ProjectsLocationsDatasetsService) Deidentify

func (r *ProjectsLocationsDatasetsService) Deidentify(sourceDataset string, deidentifydatasetrequest *DeidentifyDatasetRequest) *ProjectsLocationsDatasetsDeidentifyCall

Deidentify: Creates a new dataset containing de-identified data from the source dataset. The metadata field type is OperationMetadata. If the request is successful, the response field type is DeidentifySummary. If errors occur, error is set. The LRO result may still be successful if de-identification fails for some DICOM instances. The new de-identified dataset will not contain these failed resources. Failed resource totals are tracked in Operation.metadata. Error details are also logged to Cloud Logging. For more information, see Viewing error logs in Cloud Logging (https://cloud.google.com/healthcare/docs/how-tos/logging).

  • sourceDataset: Source dataset resource name. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`.

func (*ProjectsLocationsDatasetsService) Delete

Delete: Deletes the specified health dataset and all data contained in the dataset. Deleting a dataset does not affect the sources from which the dataset was imported (if any).

  • name: The name of the dataset to delete. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`.

func (*ProjectsLocationsDatasetsService) Get

Get: Gets any metadata associated with a dataset.

  • name: The name of the dataset to read. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`.

func (*ProjectsLocationsDatasetsService) GetIamPolicy

GetIamPolicy: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

func (*ProjectsLocationsDatasetsService) List

List: Lists the health datasets in the current project.

  • parent: The name of the project whose datasets should be listed. For example, `projects/{project_id}/locations/{location_id}`.

func (*ProjectsLocationsDatasetsService) Patch

Patch: Updates dataset metadata.

  • name: Identifier. Resource name of the dataset, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`.

func (*ProjectsLocationsDatasetsService) SetIamPolicy

SetIamPolicy: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

func (*ProjectsLocationsDatasetsService) TestIamPermissions

TestIamPermissions: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

type ProjectsLocationsDatasetsSetIamPolicyCall

type ProjectsLocationsDatasetsSetIamPolicyCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsSetIamPolicyCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsSetIamPolicyCall) Do

Do executes the "healthcare.projects.locations.datasets.setIamPolicy" call. Any non-2xx status code is an error. Response headers are in either *Policy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsSetIamPolicyCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsSetIamPolicyCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDatasetsTestIamPermissionsCall

type ProjectsLocationsDatasetsTestIamPermissionsCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsTestIamPermissionsCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDatasetsTestIamPermissionsCall) Do

Do executes the "healthcare.projects.locations.datasets.testIamPermissions" call. Any non-2xx status code is an error. Response headers are in either *TestIamPermissionsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsTestIamPermissionsCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDatasetsTestIamPermissionsCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsGetCall added in v0.32.0

type ProjectsLocationsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsGetCall) Context added in v0.32.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsGetCall) Do added in v0.32.0

Do executes the "healthcare.projects.locations.get" call. Any non-2xx status code is an error. Response headers are in either *Location.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsGetCall) Fields added in v0.32.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsGetCall) Header added in v0.32.0

func (c *ProjectsLocationsGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsGetCall) IfNoneMatch added in v0.32.0

func (c *ProjectsLocationsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsListCall added in v0.32.0

type ProjectsLocationsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsListCall) Context added in v0.32.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsListCall) Do added in v0.32.0

Do executes the "healthcare.projects.locations.list" call. Any non-2xx status code is an error. Response headers are in either *ListLocationsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsListCall) Fields added in v0.32.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsListCall) Filter added in v0.32.0

Filter sets the optional parameter "filter": A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160 (https://google.aip.dev/160).

func (*ProjectsLocationsListCall) Header added in v0.32.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsListCall) IfNoneMatch added in v0.32.0

func (c *ProjectsLocationsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsListCall) PageSize added in v0.32.0

PageSize sets the optional parameter "pageSize": The maximum number of results to return. If not set, the service selects a default.

func (*ProjectsLocationsListCall) PageToken added in v0.32.0

PageToken sets the optional parameter "pageToken": A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.

func (*ProjectsLocationsListCall) Pages added in v0.32.0

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsService

type ProjectsLocationsService struct {
	Datasets *ProjectsLocationsDatasetsService

	Services *ProjectsLocationsServicesService
	// contains filtered or unexported fields
}

func NewProjectsLocationsService

func NewProjectsLocationsService(s *Service) *ProjectsLocationsService

func (*ProjectsLocationsService) Get added in v0.32.0

Get: Gets information about a location.

- name: Resource name for the location.

func (*ProjectsLocationsService) List added in v0.32.0

List: Lists information about the supported locations for this service.

- name: The resource that owns the locations collection, if applicable.

type ProjectsLocationsServicesNlpAnalyzeEntitiesCall added in v0.57.0

type ProjectsLocationsServicesNlpAnalyzeEntitiesCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsServicesNlpAnalyzeEntitiesCall) Context added in v0.57.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsServicesNlpAnalyzeEntitiesCall) Do added in v0.57.0

Do executes the "healthcare.projects.locations.services.nlp.analyzeEntities" call. Any non-2xx status code is an error. Response headers are in either *AnalyzeEntitiesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsServicesNlpAnalyzeEntitiesCall) Fields added in v0.57.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsServicesNlpAnalyzeEntitiesCall) Header added in v0.57.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsServicesNlpService added in v0.57.0

type ProjectsLocationsServicesNlpService struct {
	// contains filtered or unexported fields
}

func NewProjectsLocationsServicesNlpService added in v0.57.0

func NewProjectsLocationsServicesNlpService(s *Service) *ProjectsLocationsServicesNlpService

func (*ProjectsLocationsServicesNlpService) AnalyzeEntities added in v0.57.0

AnalyzeEntities: Analyze heathcare entity in a document. Its response includes the recognized entity mentions and the relationships between them. AnalyzeEntities uses context aware models to detect entities.

  • nlpService: The resource name of the service of the form: "projects/{project_id}/locations/{location_id}/services/nlp".

type ProjectsLocationsServicesService added in v0.57.0

type ProjectsLocationsServicesService struct {
	Nlp *ProjectsLocationsServicesNlpService
	// contains filtered or unexported fields
}

func NewProjectsLocationsServicesService added in v0.57.0

func NewProjectsLocationsServicesService(s *Service) *ProjectsLocationsServicesService

type ProjectsService

type ProjectsService struct {
	Locations *ProjectsLocationsService
	// contains filtered or unexported fields
}

func NewProjectsService

func NewProjectsService(s *Service) *ProjectsService

type PubsubDestination added in v0.131.0

type PubsubDestination struct {
	// PubsubTopic: The Pub/Sub (https://cloud.google.com/pubsub/docs/) topic that
	// Pub/Sub messages are published on. Supplied by the client. The
	// `PubsubMessage` contains 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.
	// Topic names (https://cloud.google.com/pubsub/docs/overview#names) must be
	// scoped to a project. The Cloud Healthcare API service account,
	// service-PROJECT_NUMBER@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.
	PubsubTopic string `json:"pubsubTopic,omitempty"`
	// ForceSendFields is a list of field names (e.g. "PubsubTopic") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "PubsubTopic") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

PubsubDestination: The Pub/Sub output destination. The Cloud Healthcare Service Agent requires the `roles/pubsub.publisher` Cloud IAM role on the Pub/Sub topic.

func (PubsubDestination) MarshalJSON added in v0.131.0

func (s PubsubDestination) MarshalJSON() ([]byte, error)

type QueryAccessibleDataRequest added in v0.41.0

type QueryAccessibleDataRequest struct {
	// GcsDestination: The Cloud Storage destination. The Cloud Healthcare API
	// service account must have the `roles/storage.objectAdmin` Cloud IAM role for
	// this Cloud Storage location.
	GcsDestination *GoogleCloudHealthcareV1ConsentGcsDestination `json:"gcsDestination,omitempty"`
	// RequestAttributes: The values of request attributes associated with this
	// access request.
	RequestAttributes map[string]string `json:"requestAttributes,omitempty"`
	// ResourceAttributes: Optional. The values of resource attributes associated
	// with the type of resources being requested. If no values are specified, then
	// all resource types are included in the output.
	ResourceAttributes map[string]string `json:"resourceAttributes,omitempty"`
	// ForceSendFields is a list of field names (e.g. "GcsDestination") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "GcsDestination") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

QueryAccessibleDataRequest: Queries all data_ids that are consented for a given use in the given consent store and writes them to a specified destination. The returned Operation includes a progress counter for the number of User data mappings processed. Errors are logged to Cloud Logging (see [Viewing error logs in Cloud Logging] (https://cloud.google.com/healthcare/docs/how-tos/logging) and [QueryAccessibleData] for a sample log entry).

func (QueryAccessibleDataRequest) MarshalJSON added in v0.41.0

func (s QueryAccessibleDataRequest) MarshalJSON() ([]byte, error)

type QueryAccessibleDataResponse added in v0.48.0

type QueryAccessibleDataResponse struct {
	// GcsUris: List of files, each of which contains a list of data_id(s) that are
	// consented for a specified use in the request.
	GcsUris []string `json:"gcsUris,omitempty"`
	// ForceSendFields is a list of field names (e.g. "GcsUris") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "GcsUris") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

QueryAccessibleDataResponse: Response for successful QueryAccessibleData operations. This structure is included in the response upon operation completion.

func (QueryAccessibleDataResponse) MarshalJSON added in v0.49.0

func (s QueryAccessibleDataResponse) MarshalJSON() ([]byte, error)

type RedactConfig

type RedactConfig struct {
}

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

type RejectConsentRequest added in v0.41.0

type RejectConsentRequest struct {
	// ConsentArtifact: Optional. The resource name of the Consent artifact that
	// contains documentation of the user's rejection of the draft Consent, of the
	// form
	// `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentS
	// tores/{consent_store_id}/consentArtifacts/{consent_artifact_id}`. If the
	// draft Consent had a Consent artifact, this Consent artifact overwrites it.
	ConsentArtifact string `json:"consentArtifact,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ConsentArtifact") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ConsentArtifact") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

RejectConsentRequest: Rejects the latest revision of the specified Consent by committing a new revision with `state` updated to `REJECTED`. If the latest revision of the given Consent is in the `REJECTED` state, no new revision is committed.

func (RejectConsentRequest) MarshalJSON added in v0.41.0

func (s RejectConsentRequest) MarshalJSON() ([]byte, error)

type ReplaceWithInfoTypeConfig

type ReplaceWithInfoTypeConfig struct {
}

ReplaceWithInfoTypeConfig: 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.

type Resources

type Resources struct {
	// Resources: List of resources IDs. For example, "Patient/1234".
	Resources []string `json:"resources,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Resources") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Resources") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Resources: A list of FHIR resources.

func (Resources) MarshalJSON

func (s Resources) MarshalJSON() ([]byte, error)

type Result added in v0.41.0

type Result struct {
	// ConsentDetails: The resource names of all evaluated Consents mapped to their
	// evaluation.
	ConsentDetails map[string]ConsentEvaluation `json:"consentDetails,omitempty"`
	// Consented: Whether the resource is consented for the given use.
	Consented bool `json:"consented,omitempty"`
	// DataId: The unique identifier of the evaluated resource.
	DataId string `json:"dataId,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ConsentDetails") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ConsentDetails") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Result: The consent evaluation result for a single `data_id`.

func (Result) MarshalJSON added in v0.41.0

func (s Result) MarshalJSON() ([]byte, error)

type RevokeConsentRequest added in v0.41.0

type RevokeConsentRequest struct {
	// ConsentArtifact: Optional. The resource name of the Consent artifact that
	// contains proof of the user's revocation of the Consent, of the form
	// `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentS
	// tores/{consent_store_id}/consentArtifacts/{consent_artifact_id}`.
	ConsentArtifact string `json:"consentArtifact,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ConsentArtifact") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ConsentArtifact") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

RevokeConsentRequest: Revokes the latest revision of the specified Consent by committing a new revision with `state` updated to `REVOKED`. If the latest revision of the given Consent is in the `REVOKED` state, no new revision is committed.

func (RevokeConsentRequest) MarshalJSON added in v0.41.0

func (s RevokeConsentRequest) MarshalJSON() ([]byte, error)

type RollbackFhirResourceFilteringFields added in v0.158.0

type RollbackFhirResourceFilteringFields struct {
	// MetadataFilter: Optional. A filter expression that matches data in the
	// `Resource.meta` element. Supports all filters in AIP-160
	// (https://google.aip.dev/160) except the "has" (`:`) operator. Supports the
	// following custom functions: * `tag("") = "" for tag filtering. *
	// `extension_value_ts("") = ` for filtering extensions with a timestamp, where
	// “ is a Unix timestamp. Supports the `>`, `<`, `<=`, `>=`, and `!=`
	// comparison operators.
	MetadataFilter string `json:"metadataFilter,omitempty"`
	// OperationIds: Optional. A list of operation IDs to roll back.
	OperationIds googleapi.Uint64s `json:"operationIds,omitempty"`
	// ForceSendFields is a list of field names (e.g. "MetadataFilter") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "MetadataFilter") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

func (RollbackFhirResourceFilteringFields) MarshalJSON added in v0.158.0

func (s RollbackFhirResourceFilteringFields) MarshalJSON() ([]byte, error)

type RollbackFhirResourcesRequest added in v0.158.0

type RollbackFhirResourcesRequest struct {
	// ChangeType: Optional. CREATE/UPDATE/DELETE/ALL for reverting all txns of a
	// certain type.
	//
	// Possible values:
	//   "CHANGE_TYPE_UNSPECIFIED" - When unspecified, revert all transactions
	//   "ALL" - All transactions
	//   "CREATE" - Revert only CREATE transactions
	//   "UPDATE" - Revert only Update transactions
	//   "DELETE" - Revert only Delete transactions
	ChangeType string `json:"changeType,omitempty"`
	// ExcludeRollbacks: Optional. Specifies whether to exclude earlier rollbacks.
	ExcludeRollbacks bool `json:"excludeRollbacks,omitempty"`
	// FilteringFields: Optional. Parameters for filtering resources
	FilteringFields *RollbackFhirResourceFilteringFields `json:"filteringFields,omitempty"`
	// Force: Optional. When enabled, changes will be reverted without explicit
	// confirmation
	Force bool `json:"force,omitempty"`
	// InputGcsObject: Optional. Cloud Storage object containing list of
	// {resourceType}/{resourceId} lines, identifying resources to be reverted
	InputGcsObject string `json:"inputGcsObject,omitempty"`
	// ResultGcsBucket: Required. Bucket to deposit result
	ResultGcsBucket string `json:"resultGcsBucket,omitempty"`
	// RollbackTime: Required. Time point to rollback to.
	RollbackTime string `json:"rollbackTime,omitempty"`
	// Type: Optional. If specified, revert only resources of these types
	Type []string `json:"type,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ChangeType") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ChangeType") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

func (RollbackFhirResourcesRequest) MarshalJSON added in v0.158.0

func (s RollbackFhirResourcesRequest) MarshalJSON() ([]byte, error)

type RollbackFhirResourcesResponse added in v0.158.0

type RollbackFhirResourcesResponse struct {
	// FhirStore: The name of the FHIR store to rollback, in the format of
	// "projects/{project_id}/locations/{location_id}/datasets/{dataset_id}
	// /fhirStores/{fhir_store_id}".
	FhirStore string `json:"fhirStore,omitempty"`
	// ForceSendFields is a list of field names (e.g. "FhirStore") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "FhirStore") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

RollbackFhirResourcesResponse: Final response of rollback FIHR resources request.

func (RollbackFhirResourcesResponse) MarshalJSON added in v0.158.0

func (s RollbackFhirResourcesResponse) MarshalJSON() ([]byte, error)

type RollbackHL7MessagesFilteringFields added in v0.191.0

type RollbackHL7MessagesFilteringFields struct {
	// OperationIds: Optional. A list of operation IDs to roll back.
	OperationIds googleapi.Uint64s `json:"operationIds,omitempty"`
	// ForceSendFields is a list of field names (e.g. "OperationIds") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "OperationIds") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

RollbackHL7MessagesFilteringFields: Filtering fields for an HL7 rollback. Currently only supports a list of operation ids to roll back.

func (RollbackHL7MessagesFilteringFields) MarshalJSON added in v0.191.0

func (s RollbackHL7MessagesFilteringFields) MarshalJSON() ([]byte, error)

type RollbackHl7V2MessagesRequest added in v0.191.0

type RollbackHl7V2MessagesRequest struct {
	// ChangeType: Optional. CREATE/UPDATE/DELETE/ALL for reverting all txns of a
	// certain type.
	//
	// Possible values:
	//   "CHANGE_TYPE_UNSPECIFIED" - When unspecified, revert all transactions
	//   "ALL" - All transactions
	//   "CREATE" - Revert only CREATE transactions
	//   "UPDATE" - Revert only Update transactions
	//   "DELETE" - Revert only Delete transactions
	ChangeType string `json:"changeType,omitempty"`
	// ExcludeRollbacks: Optional. Specifies whether to exclude earlier rollbacks.
	ExcludeRollbacks bool `json:"excludeRollbacks,omitempty"`
	// FilteringFields: Optional. Parameters for filtering.
	FilteringFields *RollbackHL7MessagesFilteringFields `json:"filteringFields,omitempty"`
	// Force: Optional. When enabled, changes will be reverted without explicit
	// confirmation.
	Force bool `json:"force,omitempty"`
	// InputGcsObject: Optional. Cloud storage object containing list of
	// {resourceId} lines, identifying resources to be reverted
	InputGcsObject string `json:"inputGcsObject,omitempty"`
	// ResultGcsBucket: Required. Bucket to deposit result
	ResultGcsBucket string `json:"resultGcsBucket,omitempty"`
	// RollbackTime: Required. Times point to rollback to.
	RollbackTime string `json:"rollbackTime,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ChangeType") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ChangeType") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

RollbackHl7V2MessagesRequest: Point in time recovery rollback request.

func (RollbackHl7V2MessagesRequest) MarshalJSON added in v0.191.0

func (s RollbackHl7V2MessagesRequest) MarshalJSON() ([]byte, error)

type RollbackHl7V2MessagesResponse added in v0.191.0

type RollbackHl7V2MessagesResponse struct {
	// Hl7v2Store: The name of the HL7 store to rollback, in the format of
	// "projects/{project_id}/locations/{location_id}/datasets/{dataset_id}
	// /hl7v2Stores/{hl7v2_store_id}".
	Hl7v2Store string `json:"hl7v2Store,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Hl7v2Store") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Hl7v2Store") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

RollbackHl7V2MessagesResponse: Final response of rollback HL7v2 messages request.

func (RollbackHl7V2MessagesResponse) MarshalJSON added in v0.191.0

func (s RollbackHl7V2MessagesResponse) MarshalJSON() ([]byte, error)

type SchemaConfig

type SchemaConfig struct {
	// LastUpdatedPartitionConfig: The configuration for exported BigQuery tables
	// to be partitioned by FHIR resource's last updated time column.
	LastUpdatedPartitionConfig *TimePartitioning `json:"lastUpdatedPartitionConfig,omitempty"`
	// RecursiveStructureDepth: 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.
	RecursiveStructureDepth int64 `json:"recursiveStructureDepth,omitempty,string"`
	// SchemaType: Specifies the output schema type. Schema type is required.
	//
	// Possible values:
	//   "SCHEMA_TYPE_UNSPECIFIED" - No schema type specified. This type is
	// unsupported.
	//   "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. Additionally, extensions with a URL ending in
	// "/{existing_resource_field_name}" may cause undefined behavior.
	//   "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. Extensions with a URL ending in
	// "/{existing_resource_field_name}" will cause conflict and prevent the
	// resource from being sent to BigQuery. Analytics V2 uses more space in the
	// destination table than Analytics V1. It is generally recommended to use
	// Analytics V2 over Analytics.
	SchemaType string `json:"schemaType,omitempty"`
	// ForceSendFields is a list of field names (e.g. "LastUpdatedPartitionConfig")
	// to unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "LastUpdatedPartitionConfig") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (SchemaConfig) MarshalJSON

func (s SchemaConfig) MarshalJSON() ([]byte, error)

type SchemaGroup added in v0.41.0

type SchemaGroup struct {
	// Choice: True indicates that this is a choice group, meaning that only one of
	// its segments can exist in a given message.
	Choice bool `json:"choice,omitempty"`
	// MaxOccurs: The maximum number of times this group can be repeated. 0 or -1
	// means unbounded.
	MaxOccurs int64 `json:"maxOccurs,omitempty"`
	// Members: Nested groups and/or segments.
	Members []*GroupOrSegment `json:"members,omitempty"`
	// MinOccurs: The minimum number of times this group must be present/repeated.
	MinOccurs int64 `json:"minOccurs,omitempty"`
	// Name: The name of this group. For example, "ORDER_DETAIL".
	Name string `json:"name,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Choice") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Choice") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SchemaGroup: An HL7v2 logical group construct.

func (SchemaGroup) MarshalJSON added in v0.41.0

func (s SchemaGroup) MarshalJSON() ([]byte, error)

type SchemaPackage added in v0.41.0

type SchemaPackage struct {
	// IgnoreMinOccurs: Flag to ignore all min_occurs restrictions in the schema.
	// This means that incoming messages can omit any group, segment, field,
	// component, or subcomponent.
	IgnoreMinOccurs bool `json:"ignoreMinOccurs,omitempty"`
	// Schemas: Schema configs that are layered based on their VersionSources that
	// match the incoming message. Schema configs present in higher indices
	// override those in lower indices with the same message type and trigger event
	// if their VersionSources all match an incoming message.
	Schemas []*Hl7SchemaConfig `json:"schemas,omitempty"`
	// SchematizedParsingType: Determines how messages that fail to parse are
	// handled.
	//
	// Possible values:
	//   "SCHEMATIZED_PARSING_TYPE_UNSPECIFIED" - Unspecified schematized parsing
	// type, equivalent to `SOFT_FAIL`.
	//   "SOFT_FAIL" - Messages that fail to parse are still stored and ACKed but a
	// parser error is stored in place of the schematized data.
	//   "HARD_FAIL" - Messages that fail to parse are rejected from
	// ingestion/insertion and return an error code.
	SchematizedParsingType string `json:"schematizedParsingType,omitempty"`
	// Types: Schema type definitions that are layered based on their
	// VersionSources that match the incoming message. Type definitions present in
	// higher indices override those in lower indices with the same type name if
	// their VersionSources all match an incoming message.
	Types []*Hl7TypesConfig `json:"types,omitempty"`
	// UnexpectedSegmentHandling: Determines how unexpected segments (segments not
	// matched to the schema) are handled.
	//
	// Possible values:
	//   "UNEXPECTED_SEGMENT_HANDLING_MODE_UNSPECIFIED" - Unspecified handling
	// mode, equivalent to FAIL.
	//   "FAIL" - Unexpected segments fail to parse and return an error.
	//   "SKIP" - Unexpected segments do not fail, but are omitted from the output.
	//   "PARSE" - Unexpected segments do not fail, but are parsed in place and
	// added to the current group. If a segment has a type definition, it is used,
	// otherwise it is parsed as VARIES.
	UnexpectedSegmentHandling string `json:"unexpectedSegmentHandling,omitempty"`
	// ForceSendFields is a list of field names (e.g. "IgnoreMinOccurs") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "IgnoreMinOccurs") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (SchemaPackage) MarshalJSON added in v0.41.0

func (s SchemaPackage) MarshalJSON() ([]byte, error)

type SchemaSegment added in v0.41.0

type SchemaSegment struct {
	// MaxOccurs: The maximum number of times this segment can be present in this
	// group. 0 or -1 means unbounded.
	MaxOccurs int64 `json:"maxOccurs,omitempty"`
	// MinOccurs: The minimum number of times this segment can be present in this
	// group.
	MinOccurs int64 `json:"minOccurs,omitempty"`
	// Type: The Segment type. For example, "PID".
	Type string `json:"type,omitempty"`
	// ForceSendFields is a list of field names (e.g. "MaxOccurs") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "MaxOccurs") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SchemaSegment: An HL7v2 Segment.

func (SchemaSegment) MarshalJSON added in v0.41.0

func (s SchemaSegment) MarshalJSON() ([]byte, error)

type SchematizedData added in v0.41.0

type SchematizedData struct {
	// Data: JSON output of the parser.
	Data string `json:"data,omitempty"`
	// Error: The error output of the parser.
	Error string `json:"error,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Data") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Data") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (SchematizedData) MarshalJSON added in v0.41.0

func (s SchematizedData) MarshalJSON() ([]byte, error)

type SearchResourcesRequest

type SearchResourcesRequest struct {
	// ResourceType: Required. The FHIR resource type to search, such as Patient or
	// Observation. For a complete list, see the FHIR Resource Index (DSTU2
	// (http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), STU3
	// (http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), R4
	// (http://hl7.org/implement/standards/fhir/R4/resourcelist.html)).
	ResourceType string `json:"resourceType,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ResourceType") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ResourceType") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SearchResourcesRequest: Request to search the resources in the specified FHIR store.

func (SearchResourcesRequest) MarshalJSON

func (s SearchResourcesRequest) MarshalJSON() ([]byte, error)

type Segment

type Segment struct {
	// Fields: A mapping from the positional location to the value. The key string
	// uses zero-based indexes separated by dots to identify Fields, components and
	// sub-components. A bracket notation is also used to identify different
	// instances of a repeated field. Regex for key: (\d+)(\[\d+\])?(.\d+)?(.\d+)?
	// Examples of (key, value) pairs: * (0.1, "hemoglobin") denotes that the first
	// component of Field 0 has the value "hemoglobin". * (1.1.2, "CBC") denotes
	// that the second sub-component of the first component of Field 1 has the
	// value "CBC". * (1[0].1, "HbA1c") denotes that the first component of the
	// first Instance of Field 1, which is repeated, has the value "HbA1c".
	Fields map[string]string `json:"fields,omitempty"`
	// SegmentId: A string that indicates the type of segment. For example, EVN or
	// PID.
	SegmentId string `json:"segmentId,omitempty"`
	// SetId: Set ID for segments that can be in a set. This can be empty if it's
	// missing or isn't applicable.
	SetId string `json:"setId,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Fields") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Fields") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Segment: A segment in a structured format.

func (Segment) MarshalJSON

func (s Segment) MarshalJSON() ([]byte, error)

type SeriesMetrics added in v0.147.0

type SeriesMetrics struct {
	// BlobStorageSizeBytes: Total blob storage bytes for all instances in the
	// series.
	BlobStorageSizeBytes int64 `json:"blobStorageSizeBytes,omitempty,string"`
	// InstanceCount: Number of instances in the series.
	InstanceCount int64 `json:"instanceCount,omitempty,string"`
	// Series: The series resource path. For example,
	// `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomSto
	// res/{dicom_store_id}/dicomWeb/studies/{study_uid}/series/{series_uid}`.
	Series string `json:"series,omitempty"`
	// StructuredStorageSizeBytes: Total structured storage bytes for all instances
	// in the series.
	StructuredStorageSizeBytes int64 `json:"structuredStorageSizeBytes,omitempty,string"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "BlobStorageSizeBytes") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "BlobStorageSizeBytes") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SeriesMetrics: SeriesMetrics contains metrics describing a DICOM series.

func (SeriesMetrics) MarshalJSON added in v0.147.0

func (s SeriesMetrics) MarshalJSON() ([]byte, error)

type Service

type Service struct {
	BasePath  string // API endpoint base URL
	UserAgent string // optional additional User-Agent fragment

	Projects *ProjectsService
	// contains filtered or unexported fields
}

func New deprecated

func New(client *http.Client) (*Service, error)

New creates a new Service. It uses the provided http.Client for requests.

Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

func NewService

func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)

NewService creates a new Service.

type SetIamPolicyRequest

type SetIamPolicyRequest struct {
	// Policy: REQUIRED: The complete policy to be applied to the `resource`. The
	// size of the policy is limited to a few 10s of KB. An empty policy is a valid
	// policy but certain Google Cloud services (such as Projects) might reject
	// them.
	Policy *Policy `json:"policy,omitempty"`
	// UpdateMask: OPTIONAL: A FieldMask specifying which fields of the policy to
	// modify. Only the fields in the mask will be modified. If no mask is
	// provided, the following default mask is used: `paths: "bindings, etag"
	UpdateMask string `json:"updateMask,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Policy") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Policy") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SetIamPolicyRequest: Request message for `SetIamPolicy` method.

func (SetIamPolicyRequest) MarshalJSON

func (s SetIamPolicyRequest) MarshalJSON() ([]byte, error)

type Signature added in v0.41.0

type Signature struct {
	// Image: Optional. An image of the user's signature.
	Image *Image `json:"image,omitempty"`
	// Metadata: Optional. Metadata associated with the user's signature. For
	// example, the user's name or the user's title.
	Metadata map[string]string `json:"metadata,omitempty"`
	// SignatureTime: Optional. Timestamp of the signature.
	SignatureTime string `json:"signatureTime,omitempty"`
	// UserId: Required. User's UUID provided by the client.
	UserId string `json:"userId,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Image") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Image") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Signature: User signature.

func (Signature) MarshalJSON added in v0.41.0

func (s Signature) MarshalJSON() ([]byte, error)

type Status

type Status struct {
	// Code: The status code, which should be an enum value of google.rpc.Code.
	Code int64 `json:"code,omitempty"`
	// Details: A list of messages that carry the error details. There is a common
	// set of message types for APIs to use.
	Details []googleapi.RawMessage `json:"details,omitempty"`
	// Message: A developer-facing error message, which should be in English. Any
	// user-facing error message should be localized and sent in the
	// google.rpc.Status.details field, or localized by the client.
	Message string `json:"message,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Code") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Code") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Status: The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors).

func (Status) MarshalJSON

func (s Status) MarshalJSON() ([]byte, error)

type StreamConfig

type StreamConfig struct {
	// BigqueryDestination: 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. For example,
	// "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. BigQuery imposes a 1 MB limit on streaming
	// insert row size, therefore any resource mutation that generates more than 1
	// MB of BigQuery data is not streamed. 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. 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 are logged to Cloud Logging. For more information, see
	// Viewing error logs in Cloud Logging
	// (https://cloud.google.com/healthcare/docs/how-tos/logging)).
	BigqueryDestination *GoogleCloudHealthcareV1FhirBigQueryDestination `json:"bigqueryDestination,omitempty"`
	// 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
	// (https://cloud.google.com/healthcare/docs/how-tos/permissions-healthcare-api-gcp-products#the_cloud_healthcare_service_agent).
	// 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
	// (https://cloud.google.com/healthcare/docs/how-tos/logging)).
	DeidentifiedStoreDestination *DeidentifiedStoreDestination `json:"deidentifiedStoreDestination,omitempty"`
	// ResourceTypes: 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.
	ResourceTypes []string `json:"resourceTypes,omitempty"`
	// ForceSendFields is a list of field names (e.g. "BigqueryDestination") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "BigqueryDestination") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

StreamConfig: Contains configuration for streaming FHIR export.

func (StreamConfig) MarshalJSON

func (s StreamConfig) MarshalJSON() ([]byte, error)

type StudyMetrics added in v0.147.0

type StudyMetrics struct {
	// BlobStorageSizeBytes: Total blob storage bytes for all instances in the
	// study.
	BlobStorageSizeBytes int64 `json:"blobStorageSizeBytes,omitempty,string"`
	// InstanceCount: Number of instances in the study.
	InstanceCount int64 `json:"instanceCount,omitempty,string"`
	// SeriesCount: Number of series in the study.
	SeriesCount int64 `json:"seriesCount,omitempty,string"`
	// StructuredStorageSizeBytes: Total structured storage bytes for all instances
	// in the study.
	StructuredStorageSizeBytes int64 `json:"structuredStorageSizeBytes,omitempty,string"`
	// Study: The study resource path. For example,
	// `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomSto
	// res/{dicom_store_id}/dicomWeb/studies/{study_uid}`.
	Study string `json:"study,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "BlobStorageSizeBytes") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "BlobStorageSizeBytes") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

StudyMetrics: StudyMetrics contains metrics describing a DICOM study.

func (StudyMetrics) MarshalJSON added in v0.147.0

func (s StudyMetrics) MarshalJSON() ([]byte, error)

type TagFilterList

type TagFilterList struct {
	// Tags: Tags to be filtered. Tags must be DICOM Data Elements, File Meta
	// Elements, or Directory Structuring Elements, as defined at:
	// http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,.
	// They may be provided by "Keyword" or "Tag". For example "PatientID",
	// "00100010".
	Tags []string `json:"tags,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Tags") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Tags") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

TagFilterList: List of tags to be filtered.

func (TagFilterList) MarshalJSON

func (s TagFilterList) MarshalJSON() ([]byte, error)

type TestIamPermissionsRequest

type TestIamPermissionsRequest struct {
	// Permissions: The set of permissions to check for the `resource`. Permissions
	// with wildcards (such as `*` or `storage.*`) are not allowed. For more
	// information see IAM Overview
	// (https://cloud.google.com/iam/docs/overview#permissions).
	Permissions []string `json:"permissions,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Permissions") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Permissions") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

TestIamPermissionsRequest: Request message for `TestIamPermissions` method.

func (TestIamPermissionsRequest) MarshalJSON

func (s TestIamPermissionsRequest) MarshalJSON() ([]byte, error)

type TestIamPermissionsResponse

type TestIamPermissionsResponse struct {
	// Permissions: A subset of `TestPermissionsRequest.permissions` that the
	// caller is allowed.
	Permissions []string `json:"permissions,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Permissions") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Permissions") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

TestIamPermissionsResponse: Response message for `TestIamPermissions` method.

func (TestIamPermissionsResponse) MarshalJSON

func (s TestIamPermissionsResponse) MarshalJSON() ([]byte, error)

type TextConfig

type TextConfig struct {
	// AdditionalTransformations: Transformations to apply to the detected data,
	// overridden by `exclude_info_types`.
	AdditionalTransformations []*InfoTypeTransformation `json:"additionalTransformations,omitempty"`
	// ExcludeInfoTypes: InfoTypes to skip transforming, overriding
	// `additional_transformations`.
	ExcludeInfoTypes []string `json:"excludeInfoTypes,omitempty"`
	// Transformations: The transformations to apply to the detected data.
	// Deprecated. Use `additional_transformations` instead.
	Transformations []*InfoTypeTransformation `json:"transformations,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AdditionalTransformations")
	// to unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AdditionalTransformations") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

func (TextConfig) MarshalJSON

func (s TextConfig) MarshalJSON() ([]byte, error)

type TextSpan added in v0.57.0

type TextSpan struct {
	// BeginOffset: The unicode codepoint index of the beginning of this span.
	BeginOffset int64 `json:"beginOffset,omitempty"`
	// Content: The original text contained in this span.
	Content string `json:"content,omitempty"`
	// ForceSendFields is a list of field names (e.g. "BeginOffset") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "BeginOffset") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

TextSpan: A span of text in the provided document.

func (TextSpan) MarshalJSON added in v0.57.0

func (s TextSpan) MarshalJSON() ([]byte, error)

type TimePartitioning added in v0.111.0

type TimePartitioning struct {
	// ExpirationMs: Number of milliseconds for which to keep the storage for a
	// partition.
	ExpirationMs int64 `json:"expirationMs,omitempty,string"`
	// Type: Type of partitioning.
	//
	// Possible values:
	//   "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.
	Type string `json:"type,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ExpirationMs") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ExpirationMs") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

TimePartitioning: Configuration for FHIR BigQuery time-partitioned tables.

func (TimePartitioning) MarshalJSON added in v0.111.0

func (s TimePartitioning) MarshalJSON() ([]byte, error)

type Type added in v0.41.0

type Type struct {
	// Fields: The (sub) fields this type has (if not primitive).
	Fields []*Field `json:"fields,omitempty"`
	// Name: The name of this type. This would be the segment or datatype name. For
	// example, "PID" or "XPN".
	Name string `json:"name,omitempty"`
	// Primitive: If this is a primitive type then this field is the type of the
	// primitive For example, STRING. Leave unspecified for composite types.
	//
	// Possible values:
	//   "PRIMITIVE_UNSPECIFIED" - Not a primitive.
	//   "STRING" - String primitive.
	//   "VARIES" - Element that can have unschematized children.
	//   "UNESCAPED_STRING" - Like STRING, but all delimiters below this element
	// are ignored.
	Primitive string `json:"primitive,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Fields") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Fields") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (Type) MarshalJSON added in v0.41.0

func (s Type) MarshalJSON() ([]byte, error)

type UserDataMapping added in v0.41.0

type UserDataMapping struct {
	// ArchiveTime: Output only. Indicates the time when this mapping was archived.
	ArchiveTime string `json:"archiveTime,omitempty"`
	// Archived: Output only. Indicates whether this mapping is archived.
	Archived bool `json:"archived,omitempty"`
	// DataId: Required. A unique identifier for the mapped resource.
	DataId string `json:"dataId,omitempty"`
	// Name: Resource name of the User data mapping, of the form
	// `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentS
	// tores/{consent_store_id}/userDataMappings/{user_data_mapping_id}`.
	Name string `json:"name,omitempty"`
	// ResourceAttributes: Attributes of the resource. Only explicitly set
	// attributes are displayed here. Attribute definitions with defaults set
	// implicitly apply to these User data mappings. Attributes listed here must be
	// single valued, that is, exactly one value is specified for the field
	// "values" in each Attribute.
	ResourceAttributes []*Attribute `json:"resourceAttributes,omitempty"`
	// UserId: Required. User's UUID provided by the client.
	UserId string `json:"userId,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "ArchiveTime") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ArchiveTime") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

UserDataMapping: Maps a resource to the associated user and Attributes.

func (UserDataMapping) MarshalJSON added in v0.41.0

func (s UserDataMapping) MarshalJSON() ([]byte, error)

type ValidationConfig added in v0.61.0

type ValidationConfig struct {
	// DisableFhirpathValidation: Whether to disable FHIRPath validation for
	// incoming resources. The default value is false. 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.
	DisableFhirpathValidation bool `json:"disableFhirpathValidation,omitempty"`
	// DisableProfileValidation: Whether to disable profile validation for this
	// FHIR store. The default value is false. Set this to true to disable checking
	// incoming resources for conformance against structure definitions in this
	// FHIR store.
	DisableProfileValidation bool `json:"disableProfileValidation,omitempty"`
	// DisableReferenceTypeValidation: Whether to disable reference type validation
	// for incoming resources. The default value is false. 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.
	DisableReferenceTypeValidation bool `json:"disableReferenceTypeValidation,omitempty"`
	// DisableRequiredFieldValidation: Whether to disable required fields
	// validation for incoming resources. The default value is false. 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.
	DisableRequiredFieldValidation bool `json:"disableRequiredFieldValidation,omitempty"`
	// EnabledImplementationGuides: A list of implementation guide 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.
	EnabledImplementationGuides []string `json:"enabledImplementationGuides,omitempty"`
	// ForceSendFields is a list of field names (e.g. "DisableFhirpathValidation")
	// to unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "DisableFhirpathValidation") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ValidationConfig: Contains the configuration for FHIR profiles and validation.

func (ValidationConfig) MarshalJSON added in v0.61.0

func (s ValidationConfig) MarshalJSON() ([]byte, error)

type VersionSource added in v0.41.0

type VersionSource struct {
	// MshField: The field to extract from the MSH segment. For example, "3.1" or
	// "18[1].1".
	MshField string `json:"mshField,omitempty"`
	// Value: The value to match with the field. For example, "My Application Name"
	// or "2.3".
	Value string `json:"value,omitempty"`
	// ForceSendFields is a list of field names (e.g. "MshField") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "MshField") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (VersionSource) MarshalJSON added in v0.41.0

func (s VersionSource) MarshalJSON() ([]byte, error)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL