View Source GoogleApi.HealthCare.V1.Api.Projects (google_api_health_care v0.50.1)
API calls for all endpoints tagged Projects
.
Summary
Functions
Creates a new Attribute definition in the parent consent store.
Deletes the specified Attribute definition. Fails if the Attribute definition is referenced by any User data mapping, or the latest revision of any Consent.
Gets the specified Attribute definition.
Lists the Attribute definitions in the specified consent store.
Updates the specified Attribute definition.
Checks if a particular data_id of a User data mapping in the specified consent store is consented for the specified use.
Creates a new Consent artifact in the parent consent store.
Deletes the specified Consent artifact. Fails if the artifact is referenced by the latest revision of any Consent.
Gets the specified Consent artifact.
Lists the Consent artifacts in the specified consent store.
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.
Creates a new Consent in the parent consent store.
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.
Deletes the specified revision of a Consent. An INVALID_ARGUMENT error occurs if the specified revision is the latest revision.
Gets the specified revision of a Consent, or the latest revision if revision_id
is not specified in the resource name.
Lists the Consent in the given consent store, returning each Consent's latest revision.
Lists the revisions of the specified Consent in reverse chronological order.
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.
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.
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.
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.
Deletes the specified consent store and removes all the consent store's data.
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.
Gets the specified consent store.
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Lists the consent stores in the specified dataset.
Updates the specified consent store.
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). 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}/consentStores/{consent_store_id}
. json jsonPayload: { @type: "type.googleapis.com/google.cloud.healthcare.logging.QueryAccessibleDataLogEntry" error: { code: 9 message: "failed to evaluate consent policy" } resourceName: "projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{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}/operations/{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"
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
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.
Archives the specified User data mapping.
Creates a new User data mapping in the parent consent store.
Deletes the specified User data mapping.
Gets the specified User data mapping.
Lists the User data mappings in the specified consent store.
Updates the specified User data mapping.
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.
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
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.
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.
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).
Creates a new DICOM store within the parent dataset.
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).
Deletes the specified DICOM store and removes all images that are contained within it.
GetStudyMetrics returns metrics for a study.
GetSeriesMetrics returns metrics for a series.
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. The metadata field type is OperationMetadata.
Gets the specified DICOM store.
Gets metrics associated with the DICOM store.
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
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. The metadata field type is OperationMetadata.
Lists the DICOM stores in the given dataset.
Updates the specified DICOM store.
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 in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see Search for DICOM data.
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 in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see Search for DICOM data.
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 in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForStudies, see Search for DICOM data.
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
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 in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see Store DICOM data.
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.
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 in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudyMetadata, see Retrieve metadata.
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 in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudy, see Retrieve DICOM data.
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 in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see Search for DICOM data.
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 in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see Search for DICOM data.
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.
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.
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 in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveFrames, see Retrieve DICOM data.
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 in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedFrames, see Retrieve consumer image formats.
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 and DICOM instances in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstance, see Retrieve an instance.
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 in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstanceMetadata, see Retrieve metadata.
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 in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedInstance, see Retrieve consumer image formats.
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 in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeriesMetadata, see Retrieve metadata.
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 in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeries, see Retrieve DICOM data.
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 in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see Search for DICOM data.
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 in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see Store DICOM data.
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.
Creates a new FHIR store within the parent dataset.
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).
Deletes the specified FHIR store and removes all resources within it.
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). 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.
Retrieves a Patient resource and resources related to that patient. Implements the FHIR extended operation Patient-everything (DSTU2, STU3, R4). 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, STU3, R4), 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.
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.
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, STU3, or R4). 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.
Gets the FHIR capability statement (STU3, R4), or the conformance statement in the DSTU2 case for the store, which contains a description of functionality supported by the server. Implements the FHIR standard capabilities interaction (STU3, R4), or the conformance interaction in the DSTU2 case. On success, the response body contains a JSON-encoded representation of a CapabilityStatement
resource.
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.
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 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.
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.
Creates a FHIR resource. Implements the FHIR standard create interaction (DSTU2, STU3, R4), which creates a new resource with a server-assigned resource ID. Also supports the FHIR standard conditional create interaction (DSTU2, STU3, R4), 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.
Deletes a FHIR resource. Implements the FHIR standard delete interaction (DSTU2, STU3, R4). 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.
Executes all the requests in the given Bundle. Implements the FHIR standard batch/transaction interaction (DSTU2, STU3, R4). 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, STU3, R4) and transaction processing rules (DSTU2, STU3, R4). 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. For samples that show how to call executeBundle
, see Managing FHIR resources using FHIR bundles.
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, STU3, R4). 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.
Updates part of an existing resource by applying the operations specified in a JSON Patch document. Implements the FHIR standard patch interaction (STU3, R4). 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.
Gets the contents of a FHIR resource. Implements the FHIR standard read interaction (DSTU2, STU3, R4). Also supports the FHIR standard conditional read interaction (DSTU2, STU3, R4) 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.
Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction (DSTU2, STU3, R4) using the search semantics described in the FHIR Search specification (DSTU2, STU3, R4). 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, R4). 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 and Advanced FHIR search features.
Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction (DSTU2, STU3, R4) using the search semantics described in the FHIR Search specification (DSTU2, STU3, R4). 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, R4). 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 and Advanced FHIR search features.
Updates the entire contents of a resource. Implements the FHIR standard update interaction (DSTU2, STU3, R4). 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.
Gets the contents of a version (current or historical) of a FHIR resource by version ID. Implements the FHIR standard vread interaction (DSTU2, STU3, R4). 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.
Gets the configuration of the specified FHIR store.
Gets metrics associated with the FHIR store.
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
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). 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.
Lists the FHIR stores in the given dataset.
Updates the configuration of the specified FHIR store.
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). 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.
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
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.
Gets any metadata associated with a dataset.
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Creates a new HL7v2 store within the parent dataset.
Deletes the specified HL7v2 store and removes all messages that it contains.
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.
Gets the specified HL7v2 store.
Gets metrics associated with the HL7v2 store.
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
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). 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.
Lists the HL7v2 stores in the given dataset.
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.
Deletes an HL7v2 message.
Gets an HL7v2 message.
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.
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.
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.
Updates the HL7v2 store.
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
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.
Lists the health datasets in the current project.
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
.
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.
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
.
Updates dataset metadata.
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
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.
Gets information about a location.
Lists information about the supported locations for this service.
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.
Functions
healthcare_projects_locations_datasets_consent_stores_attribute_definitions_create(connection, projects_id, locations_id, datasets_id, consent_stores_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_consent_stores_attribute_definitions_create( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.AttributeDefinition.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a new Attribute definition in the parent consent store.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. The name of the consent store that this Attribute definition belongs to. -
locations_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
consent_stores_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:attributeDefinitionId
(type:String.t
) - 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. -
:body
(type:GoogleApi.HealthCare.V1.Model.AttributeDefinition.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.AttributeDefinition{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_consent_stores_attribute_definitions_delete(connection, projects_id, locations_id, datasets_id, consent_stores_id, attribute_definitions_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_consent_stores_attribute_definitions_delete( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes the specified Attribute definition. Fails if the Attribute definition is referenced by any User data mapping, or the latest revision of any Consent.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Required. 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. -
locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
consent_stores_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
attribute_definitions_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.Empty{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_consent_stores_attribute_definitions_get(connection, projects_id, locations_id, datasets_id, consent_stores_id, attribute_definitions_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_consent_stores_attribute_definitions_get( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.AttributeDefinition.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the specified Attribute definition.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Required. The resource name of the Attribute definition to get. -
locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
consent_stores_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
attribute_definitions_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.AttributeDefinition{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_consent_stores_attribute_definitions_list(connection, projects_id, locations_id, datasets_id, consent_stores_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_consent_stores_attribute_definitions_list( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.ListAttributeDefinitionsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists the Attribute definitions in the specified consent store.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. Name of the consent store to retrieve Attribute definitions from. -
locations_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
consent_stores_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter
(type:String.t
) - Optional. Restricts the attributes returned to those matching a filter. The only field available for filtering iscategory
. For example,filter=category=\"REQUEST\"
. -
:pageSize
(type:integer()
) - Optional. 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. -
:pageToken
(type:String.t
) - Optional. Token to retrieve the next page of results or empty to get the first page.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.ListAttributeDefinitionsResponse{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_consent_stores_attribute_definitions_patch(connection, projects_id, locations_id, datasets_id, consent_stores_id, attribute_definitions_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_consent_stores_attribute_definitions_patch( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.AttributeDefinition.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates the specified Attribute definition.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofattributeDefinition.name
. Identifier. Resource name of the Attribute definition, of the formprojects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/attributeDefinitions/{attribute_definition_id}
. Cannot be changed after creation. -
locations_id
(type:String.t
) - Part ofattributeDefinition.name
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofattributeDefinition.name
. See documentation ofprojectsId
. -
consent_stores_id
(type:String.t
) - Part ofattributeDefinition.name
. See documentation ofprojectsId
. -
attribute_definitions_id
(type:String.t
) - Part ofattributeDefinition.name
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:updateMask
(type:String.t
) - Required. The update mask that applies to the resource. For theFieldMask
definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask. Only thedescription
,allowed_values
,consent_default_values
anddata_mapping_default_value
fields can be updated. The updatedallowed_values
must contain all values from the previousallowed_values
. -
:body
(type:GoogleApi.HealthCare.V1.Model.AttributeDefinition.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.AttributeDefinition{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_consent_stores_check_data_access(connection, projects_id, locations_id, datasets_id, consent_stores_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_consent_stores_check_data_access( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.CheckDataAccessResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Checks if a particular data_id of a User data mapping in the specified consent store is consented for the specified use.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofconsentStore
. Required. Name of the consent store where the requested data_id is stored, of the formprojects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}
. -
locations_id
(type:String.t
) - Part ofconsentStore
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofconsentStore
. See documentation ofprojectsId
. -
consent_stores_id
(type:String.t
) - Part ofconsentStore
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.HealthCare.V1.Model.CheckDataAccessRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.CheckDataAccessResponse{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_consent_stores_consent_artifacts_create(connection, projects_id, locations_id, datasets_id, consent_stores_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_consent_stores_consent_artifacts_create( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.ConsentArtifact.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a new Consent artifact in the parent consent store.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. The name of the consent store this Consent artifact belongs to. -
locations_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
consent_stores_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.HealthCare.V1.Model.ConsentArtifact.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.ConsentArtifact{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_consent_stores_consent_artifacts_delete(connection, projects_id, locations_id, datasets_id, consent_stores_id, consent_artifacts_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_consent_stores_consent_artifacts_delete( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes the specified Consent artifact. Fails if the artifact is referenced by the latest revision of any Consent.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Required. 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. -
locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
consent_stores_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
consent_artifacts_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.Empty{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_consent_stores_consent_artifacts_get(connection, projects_id, locations_id, datasets_id, consent_stores_id, consent_artifacts_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_consent_stores_consent_artifacts_get( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.ConsentArtifact.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the specified Consent artifact.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Required. The resource name of the Consent artifact to retrieve. -
locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
consent_stores_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
consent_artifacts_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.ConsentArtifact{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_consent_stores_consent_artifacts_list(connection, projects_id, locations_id, datasets_id, consent_stores_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_consent_stores_consent_artifacts_list( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.ListConsentArtifactsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists the Consent artifacts in the specified consent store.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. Name of the consent store to retrieve consent artifacts from. -
locations_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
consent_stores_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter
(type:String.t
) - Optional. 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 withgreat
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 theNOT
operator to an expression to negate it. A date field value must be written inyyyy-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 theNOT
operator to an expression to negate it. Multiple field query expressions can be combined in one query by addingAND
orOR
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 theNOT
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\"
orfilter=HasMetadata(\"testkey\")
. -
:pageSize
(type:integer()
) - Optional. 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. -
:pageToken
(type:String.t
) - Optional. The next_page_token value returned from the previous List request, if any.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.ListConsentArtifactsResponse{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_consent_stores_consents_activate(connection, projects_id, locations_id, datasets_id, consent_stores_id, consents_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_consent_stores_consents_activate( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.Consent.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Required. The resource name of the Consent to activate, of the formprojects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}
. An INVALID_ARGUMENT error occurs ifrevision_id
is specified in the name. -
locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
consent_stores_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
consents_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.HealthCare.V1.Model.ActivateConsentRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.Consent{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_consent_stores_consents_create(connection, projects_id, locations_id, datasets_id, consent_stores_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_consent_stores_consents_create( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.Consent.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a new Consent in the parent consent store.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. Name of the consent store. -
locations_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
consent_stores_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.HealthCare.V1.Model.Consent.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.Consent{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_consent_stores_consents_delete(connection, projects_id, locations_id, datasets_id, consent_stores_id, consents_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_consent_stores_consents_delete( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Required. The resource name of the Consent to delete, of the formprojects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}
. An INVALID_ARGUMENT error occurs ifrevision_id
is specified in the name. -
locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
consent_stores_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
consents_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.Empty{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_consent_stores_consents_delete_revision(connection, projects_id, locations_id, datasets_id, consent_stores_id, consents_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_consent_stores_consents_delete_revision( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes the specified revision of a Consent. An INVALID_ARGUMENT error occurs if the specified revision is the latest revision.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Required. The resource name of the Consent revision to delete, of the formprojects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}@{revision_id}
. An INVALID_ARGUMENT error occurs ifrevision_id
is not specified in the name. -
locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
consent_stores_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
consents_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.Empty{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_consent_stores_consents_get(connection, projects_id, locations_id, datasets_id, consent_stores_id, consents_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_consent_stores_consents_get( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.Consent.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the specified revision of a Consent, or the latest revision if revision_id
is not specified in the resource name.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Required. The resource name of the Consent to retrieve, of the formprojects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{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}/consentStores/{consent_store_id}/consents/{consent_id}@{revision_id}
-
locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
consent_stores_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
consents_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.Consent{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_consent_stores_consents_list(connection, projects_id, locations_id, datasets_id, consent_stores_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_consent_stores_consents_list( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.ListConsentsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists the Consent in the given consent store, returning each Consent's latest revision.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. Name of the consent store to retrieve Consents from. -
locations_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
consent_stores_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter
(type:String.t
) - Optional. 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 withgreat
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 theNOT
operator to an expression to negate it. A date field value must be written inyyyy-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 theNOT
operator to an expression to negate it. Multiple field query expressions can be combined in one query by addingAND
orOR
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 theNOT
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\"
orfilter=HasMetadata(\"testkey\")
. -
:pageSize
(type:integer()
) - Optional. Limit on the number of Consents to return in a single response. If not specified, 100 is used. May not be larger than 1000. -
:pageToken
(type:String.t
) - Optional. The next_page_token value returned from the previous List request, if any.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.ListConsentsResponse{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_consent_stores_consents_list_revisions(connection, projects_id, locations_id, datasets_id, consent_stores_id, consents_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_consent_stores_consents_list_revisions( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.ListConsentRevisionsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists the revisions of the specified Consent in reverse chronological order.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Required. The resource name of the Consent to retrieve revisions for. -
locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
consent_stores_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
consents_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter
(type:String.t
) - Optional. 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 withgreat
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 theNOT
operator to an expression to negate it. A date field value must be written inyyyy-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 theNOT
operator to an expression to negate it. Multiple field query expressions can be combined in one query by addingAND
orOR
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 theNOT
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\"
orfilter=HasMetadata(\"testkey\")
. -
:pageSize
(type:integer()
) - Optional. Limit on the number of revisions to return in a single response. If not specified, 100 is used. May not be larger than 1000. -
:pageToken
(type:String.t
) - Optional. Token to retrieve the next page of results or empty if there are no more results in the list.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.ListConsentRevisionsResponse{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_consent_stores_consents_patch(connection, projects_id, locations_id, datasets_id, consent_stores_id, consents_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_consent_stores_consents_patch( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.Consent.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofconsent.name
. Identifier. Resource name of the Consent, of the formprojects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}
. Cannot be changed after creation. -
locations_id
(type:String.t
) - Part ofconsent.name
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofconsent.name
. See documentation ofprojectsId
. -
consent_stores_id
(type:String.t
) - Part ofconsent.name
. See documentation ofprojectsId
. -
consents_id
(type:String.t
) - Part ofconsent.name
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:updateMask
(type:String.t
) - Required. The update mask to apply to the resource. For theFieldMask
definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask. Only theuser_id
,policies
,consent_artifact
, andmetadata
fields can be updated. -
:body
(type:GoogleApi.HealthCare.V1.Model.Consent.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.Consent{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_consent_stores_consents_reject(connection, projects_id, locations_id, datasets_id, consent_stores_id, consents_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_consent_stores_consents_reject( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.Consent.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Required. The resource name of the Consent to reject, of the formprojects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}
. An INVALID_ARGUMENT error occurs ifrevision_id
is specified in the name. -
locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
consent_stores_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
consents_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.HealthCare.V1.Model.RejectConsentRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.Consent{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_consent_stores_consents_revoke(connection, projects_id, locations_id, datasets_id, consent_stores_id, consents_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_consent_stores_consents_revoke( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.Consent.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Required. The resource name of the Consent to revoke, of the formprojects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}
. An INVALID_ARGUMENT error occurs ifrevision_id
is specified in the name. -
locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
consent_stores_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
consents_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.HealthCare.V1.Model.RevokeConsentRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.Consent{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_consent_stores_create(connection, projects_id, locations_id, datasets_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_consent_stores_create( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.ConsentStore.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. The name of the dataset this consent store belongs to. -
locations_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:consentStoreId
(type:String.t
) - 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. -
:body
(type:GoogleApi.HealthCare.V1.Model.ConsentStore.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.ConsentStore{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_consent_stores_delete(connection, projects_id, locations_id, datasets_id, consent_stores_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_consent_stores_delete( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes the specified consent store and removes all the consent store's data.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Required. The resource name of the consent store to delete. -
locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
consent_stores_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.Empty{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_consent_stores_evaluate_user_consents(connection, projects_id, locations_id, datasets_id, consent_stores_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_consent_stores_evaluate_user_consents( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.EvaluateUserConsentsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofconsentStore
. Required. Name of the consent store to retrieve User data mappings from. -
locations_id
(type:String.t
) - Part ofconsentStore
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofconsentStore
. See documentation ofprojectsId
. -
consent_stores_id
(type:String.t
) - Part ofconsentStore
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.HealthCare.V1.Model.EvaluateUserConsentsRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.EvaluateUserConsentsResponse{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_consent_stores_get(connection, projects_id, locations_id, datasets_id, consent_stores_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_consent_stores_get( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.ConsentStore.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the specified consent store.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Required. The resource name of the consent store to get. -
locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
consent_stores_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.ConsentStore{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_consent_stores_get_iam_policy(connection, projects_id, locations_id, datasets_id, consent_stores_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_consent_stores_get_iam_policy( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofresource
. REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field. -
locations_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
consent_stores_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:"options.requestedPolicyVersion"
(type:integer()
) - Optional. 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.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.Policy{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_consent_stores_list(connection, projects_id, locations_id, datasets_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_consent_stores_list( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.ListConsentStoresResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists the consent stores in the specified dataset.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. Name of the dataset. -
locations_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter
(type:String.t
) - Optional. Restricts the stores returned to those matching a filter. Only filtering on labels is supported. For example,filter=labels.key=value
. -
:pageSize
(type:integer()
) - Optional. 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. -
:pageToken
(type:String.t
) - Optional. Token to retrieve the next page of results, or empty to get the first page.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.ListConsentStoresResponse{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_consent_stores_patch(connection, projects_id, locations_id, datasets_id, consent_stores_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_consent_stores_patch( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.ConsentStore.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates the specified consent store.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofconsentStore.name
. Identifier. Resource name of the consent store, of the formprojects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}
. Cannot be changed after creation. -
locations_id
(type:String.t
) - Part ofconsentStore.name
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofconsentStore.name
. See documentation ofprojectsId
. -
consent_stores_id
(type:String.t
) - Part ofconsentStore.name
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:updateMask
(type:String.t
) - Required. The update mask that applies to the resource. For theFieldMask
definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask. Only thelabels
,default_consent_ttl
, andenable_consent_create_on_update
fields are allowed to be updated. -
:body
(type:GoogleApi.HealthCare.V1.Model.ConsentStore.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.ConsentStore{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_consent_stores_query_accessible_data(connection, projects_id, locations_id, datasets_id, consent_stores_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_consent_stores_query_accessible_data( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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). 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}/consentStores/{consent_store_id}
. json jsonPayload: { @type: "type.googleapis.com/google.cloud.healthcare.logging.QueryAccessibleDataLogEntry" error: { code: 9 message: "failed to evaluate consent policy" } resourceName: "projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{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}/operations/{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"
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofconsentStore
. Required. Name of the consent store to retrieve User data mappings from. -
locations_id
(type:String.t
) - Part ofconsentStore
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofconsentStore
. See documentation ofprojectsId
. -
consent_stores_id
(type:String.t
) - Part ofconsentStore
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.HealthCare.V1.Model.QueryAccessibleDataRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.Operation{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_consent_stores_set_iam_policy(connection, projects_id, locations_id, datasets_id, consent_stores_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_consent_stores_set_iam_policy( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofresource
. REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field. -
locations_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
consent_stores_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.HealthCare.V1.Model.SetIamPolicyRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.Policy{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_consent_stores_test_iam_permissions(connection, projects_id, locations_id, datasets_id, consent_stores_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_consent_stores_test_iam_permissions( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.TestIamPermissionsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofresource
. REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field. -
locations_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
consent_stores_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.HealthCare.V1.Model.TestIamPermissionsRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.TestIamPermissionsResponse{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_consent_stores_user_data_mappings_archive(connection, projects_id, locations_id, datasets_id, consent_stores_id, user_data_mappings_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_consent_stores_user_data_mappings_archive( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.ArchiveUserDataMappingResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Archives the specified User data mapping.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Required. The resource name of the User data mapping to archive. -
locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
consent_stores_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
user_data_mappings_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.HealthCare.V1.Model.ArchiveUserDataMappingRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.ArchiveUserDataMappingResponse{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_consent_stores_user_data_mappings_create(connection, projects_id, locations_id, datasets_id, consent_stores_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_consent_stores_user_data_mappings_create( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.UserDataMapping.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a new User data mapping in the parent consent store.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. Name of the consent store. -
locations_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
consent_stores_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.HealthCare.V1.Model.UserDataMapping.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.UserDataMapping{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_consent_stores_user_data_mappings_delete(connection, projects_id, locations_id, datasets_id, consent_stores_id, user_data_mappings_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_consent_stores_user_data_mappings_delete( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes the specified User data mapping.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Required. The resource name of the User data mapping to delete. -
locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
consent_stores_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
user_data_mappings_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.Empty{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_consent_stores_user_data_mappings_get(connection, projects_id, locations_id, datasets_id, consent_stores_id, user_data_mappings_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_consent_stores_user_data_mappings_get( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.UserDataMapping.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the specified User data mapping.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Required. The resource name of the User data mapping to retrieve. -
locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
consent_stores_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
user_data_mappings_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.UserDataMapping{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_consent_stores_user_data_mappings_list(connection, projects_id, locations_id, datasets_id, consent_stores_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_consent_stores_user_data_mappings_list( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.ListUserDataMappingsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists the User data mappings in the specified consent store.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. Name of the consent store to retrieve User data mappings from. -
locations_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
consent_stores_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter
(type:String.t
) - Optional. 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 withgreat
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 theNOT
operator to an expression to negate it. A date field value must be written inyyyy-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 theNOT
operator to an expression to negate it. Multiple field query expressions can be combined in one query by addingAND
orOR
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 theNOT
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 -
:pageSize
(type:integer()
) - 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. -
:pageToken
(type:String.t
) - Optional. Token to retrieve the next page of results, or empty to get the first page.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.ListUserDataMappingsResponse{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_consent_stores_user_data_mappings_patch(connection, projects_id, locations_id, datasets_id, consent_stores_id, user_data_mappings_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_consent_stores_user_data_mappings_patch( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.UserDataMapping.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates the specified User data mapping.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofuserDataMapping.name
. Resource name of the User data mapping, of the formprojects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/userDataMappings/{user_data_mapping_id}
. -
locations_id
(type:String.t
) - Part ofuserDataMapping.name
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofuserDataMapping.name
. See documentation ofprojectsId
. -
consent_stores_id
(type:String.t
) - Part ofuserDataMapping.name
. See documentation ofprojectsId
. -
user_data_mappings_id
(type:String.t
) - Part ofuserDataMapping.name
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:updateMask
(type:String.t
) - Required. The update mask that applies to the resource. For theFieldMask
definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask. Only thedata_id
,user_id
andresource_attributes
fields can be updated. -
:body
(type:GoogleApi.HealthCare.V1.Model.UserDataMapping.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.UserDataMapping{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_create(connection, projects_id, locations_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_create( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. The name of the project where the server creates the dataset. For example,projects/{project_id}/locations/{location_id}
. -
locations_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:datasetId
(type:String.t
) - Required. The ID of the dataset that is being created. The string must match the following regex:[\p{L}\p{N}_\-\.]{1,256}
. -
:body
(type:GoogleApi.HealthCare.V1.Model.Dataset.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.Operation{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_data_mapper_workspaces_get_iam_policy(connection, projects_id, locations_id, datasets_id, data_mapper_workspaces_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_data_mapper_workspaces_get_iam_policy( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofresource
. REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field. -
locations_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
data_mapper_workspaces_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:"options.requestedPolicyVersion"
(type:integer()
) - Optional. 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.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.Policy{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_data_mapper_workspaces_set_iam_policy(connection, projects_id, locations_id, datasets_id, data_mapper_workspaces_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_data_mapper_workspaces_set_iam_policy( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofresource
. REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field. -
locations_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
data_mapper_workspaces_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.HealthCare.V1.Model.SetIamPolicyRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.Policy{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_data_mapper_workspaces_test_iam_permissions(connection, projects_id, locations_id, datasets_id, data_mapper_workspaces_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_data_mapper_workspaces_test_iam_permissions( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.TestIamPermissionsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofresource
. REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field. -
locations_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
data_mapper_workspaces_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.HealthCare.V1.Model.TestIamPermissionsRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.TestIamPermissionsResponse{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_deidentify(connection, projects_id, locations_id, datasets_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_deidentify( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofsourceDataset
. Required. Source dataset resource name. For example,projects/{project_id}/locations/{location_id}/datasets/{dataset_id}
. -
locations_id
(type:String.t
) - Part ofsourceDataset
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofsourceDataset
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.HealthCare.V1.Model.DeidentifyDatasetRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.Operation{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_delete(connection, projects_id, locations_id, datasets_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_delete( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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).
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Required. The name of the dataset to delete. For example,projects/{project_id}/locations/{location_id}/datasets/{dataset_id}
. -
locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.Empty{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_dicom_stores_create(connection, projects_id, locations_id, datasets_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_dicom_stores_create( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.DicomStore.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a new DICOM store within the parent dataset.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. The name of the dataset this DICOM store belongs to. -
locations_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:dicomStoreId
(type:String.t
) - Required. The ID of the DICOM store that is being created. Any string value up to 256 characters in length. -
:body
(type:GoogleApi.HealthCare.V1.Model.DicomStore.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.DicomStore{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_dicom_stores_deidentify(connection, projects_id, locations_id, datasets_id, dicom_stores_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_dicom_stores_deidentify( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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).
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofsourceStore
. Required. Source DICOM store resource name. For example,projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}
. -
locations_id
(type:String.t
) - Part ofsourceStore
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofsourceStore
. See documentation ofprojectsId
. -
dicom_stores_id
(type:String.t
) - Part ofsourceStore
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.HealthCare.V1.Model.DeidentifyDicomStoreRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.Operation{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_dicom_stores_delete(connection, projects_id, locations_id, datasets_id, dicom_stores_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_dicom_stores_delete( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes the specified DICOM store and removes all images that are contained within it.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Required. The resource name of the DICOM store to delete. -
locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
dicom_stores_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.Empty{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_dicom_stores_dicom_web_studies_get_study_metrics(connection, projects_id, locations_id, datasets_id, dicom_stores_id, studies_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_dicom_stores_dicom_web_studies_get_study_metrics( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.StudyMetrics.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
GetStudyMetrics returns metrics for a study.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofstudy
. Required. The study resource path. For example,projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}/dicomWeb/studies/{study_uid}
. -
locations_id
(type:String.t
) - Part ofstudy
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofstudy
. See documentation ofprojectsId
. -
dicom_stores_id
(type:String.t
) - Part ofstudy
. See documentation ofprojectsId
. -
studies_id
(type:String.t
) - Part ofstudy
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.StudyMetrics{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_dicom_stores_dicom_web_studies_series_get_series_metrics(connection, projects_id, locations_id, datasets_id, dicom_stores_id, studies_id, series_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_dicom_stores_dicom_web_studies_series_get_series_metrics( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.SeriesMetrics.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
GetSeriesMetrics returns metrics for a series.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofseries
. Required. The series resource path. For example,projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}/dicomWeb/studies/{study_uid}/series/{series_uid}
. -
locations_id
(type:String.t
) - Part ofseries
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofseries
. See documentation ofprojectsId
. -
dicom_stores_id
(type:String.t
) - Part ofseries
. See documentation ofprojectsId
. -
studies_id
(type:String.t
) - Part ofseries
. See documentation ofprojectsId
. -
series_id
(type:String.t
) - Part ofseries
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.SeriesMetrics{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_dicom_stores_export(connection, projects_id, locations_id, datasets_id, dicom_stores_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_dicom_stores_export( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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. The metadata field type is OperationMetadata.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Required. The DICOM store resource name from which to export the data. For example,projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}
. -
locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
dicom_stores_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.HealthCare.V1.Model.ExportDicomDataRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.Operation{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_dicom_stores_get(connection, projects_id, locations_id, datasets_id, dicom_stores_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_dicom_stores_get( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.DicomStore.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the specified DICOM store.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Required. The resource name of the DICOM store to get. -
locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
dicom_stores_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.DicomStore{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_dicom_stores_get_dicom_store_metrics(connection, projects_id, locations_id, datasets_id, dicom_stores_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_dicom_stores_get_dicom_store_metrics( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.DicomStoreMetrics.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets metrics associated with the DICOM store.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Required. The resource name of the DICOM store to get metrics for. -
locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
dicom_stores_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.DicomStoreMetrics{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_dicom_stores_get_iam_policy(connection, projects_id, locations_id, datasets_id, dicom_stores_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_dicom_stores_get_iam_policy( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofresource
. REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field. -
locations_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
dicom_stores_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:"options.requestedPolicyVersion"
(type:integer()
) - Optional. 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.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.Policy{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_dicom_stores_import(connection, projects_id, locations_id, datasets_id, dicom_stores_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_dicom_stores_import( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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. The metadata field type is OperationMetadata.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Required. The name of the DICOM store resource into which the data is imported. For example,projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}
. -
locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
dicom_stores_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.HealthCare.V1.Model.ImportDicomDataRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.Operation{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_dicom_stores_list(connection, projects_id, locations_id, datasets_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_dicom_stores_list( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.ListDicomStoresResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists the DICOM stores in the given dataset.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. Name of the dataset. -
locations_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter
(type:String.t
) - 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 withgreat
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 theNOT
operator to an expression to negate it. A date field value must be written inyyyy-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 theNOT
operator to an expression to negate it. Multiple field query expressions can be combined in one query by addingAND
orOR
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 theNOT
operator to an expression to negate it. Only filtering on labels is supported. For example,labels.key=value
. -
:pageSize
(type:integer()
) - 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. -
:pageToken
(type:String.t
) - The next_page_token value returned from the previous List request, if any.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.ListDicomStoresResponse{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_dicom_stores_patch(connection, projects_id, locations_id, datasets_id, dicom_stores_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_dicom_stores_patch( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.DicomStore.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates the specified DICOM store.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofdicomStore.name
. Identifier. Resource name of the DICOM store, of the formprojects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}
. -
locations_id
(type:String.t
) - Part ofdicomStore.name
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofdicomStore.name
. See documentation ofprojectsId
. -
dicom_stores_id
(type:String.t
) - Part ofdicomStore.name
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:updateMask
(type:String.t
) - Required. The update mask applies to the resource. For theFieldMask
definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask -
:body
(type:GoogleApi.HealthCare.V1.Model.DicomStore.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.DicomStore{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_dicom_stores_search_for_instances(connection, projects_id, locations_id, datasets_id, dicom_stores_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_dicom_stores_search_for_instances( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.HttpBody.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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 in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see Search for DICOM data.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. The name of the DICOM store that is being accessed. For example,projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}
. -
locations_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
dicom_stores_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.HttpBody{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_dicom_stores_search_for_series(connection, projects_id, locations_id, datasets_id, dicom_stores_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_dicom_stores_search_for_series( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.HttpBody.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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 in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see Search for DICOM data.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. The name of the DICOM store that is being accessed. For example,projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}
. -
locations_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
dicom_stores_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.HttpBody{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_dicom_stores_search_for_studies(connection, projects_id, locations_id, datasets_id, dicom_stores_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_dicom_stores_search_for_studies( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.HttpBody.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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 in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForStudies, see Search for DICOM data.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. The name of the DICOM store that is being accessed. For example,projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}
. -
locations_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
dicom_stores_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.HttpBody{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_dicom_stores_set_iam_policy(connection, projects_id, locations_id, datasets_id, dicom_stores_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_dicom_stores_set_iam_policy( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofresource
. REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field. -
locations_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
dicom_stores_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.HealthCare.V1.Model.SetIamPolicyRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.Policy{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_dicom_stores_store_instances(connection, projects_id, locations_id, datasets_id, dicom_stores_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_dicom_stores_store_instances( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.HttpBody.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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 in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see Store DICOM data.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. The name of the DICOM store that is being accessed. For example,projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}
. -
locations_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
dicom_stores_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.HealthCare.V1.Model.HttpBody.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.HttpBody{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_dicom_stores_studies_delete(connection, projects_id, locations_id, datasets_id, dicom_stores_id, studies_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_dicom_stores_studies_delete( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. -
locations_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
dicom_stores_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
studies_id
(type:String.t
) - Part ofdicomWebPath
. Required. The path of the DeleteStudy request. For example,studies/{study_uid}
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.Operation{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_dicom_stores_studies_retrieve_metadata(connection, projects_id, locations_id, datasets_id, dicom_stores_id, studies_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_dicom_stores_studies_retrieve_metadata( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.HttpBody.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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 in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudyMetadata, see Retrieve metadata.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. The name of the DICOM store that is being accessed. For example,projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}
. -
locations_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
dicom_stores_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
studies_id
(type:String.t
) - Part ofdicomWebPath
. Required. The path of the RetrieveStudyMetadata DICOMweb request. For example,studies/{study_uid}/metadata
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.HttpBody{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_dicom_stores_studies_retrieve_study(connection, projects_id, locations_id, datasets_id, dicom_stores_id, studies_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_dicom_stores_studies_retrieve_study( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.HttpBody.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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 in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudy, see Retrieve DICOM data.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. The name of the DICOM store that is being accessed. For example,projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}
. -
locations_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
dicom_stores_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
studies_id
(type:String.t
) - Part ofdicomWebPath
. Required. The path of the RetrieveStudy DICOMweb request. For example,studies/{study_uid}
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.HttpBody{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_dicom_stores_studies_search_for_instances(connection, projects_id, locations_id, datasets_id, dicom_stores_id, studies_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_dicom_stores_studies_search_for_instances( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.HttpBody.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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 in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see Search for DICOM data.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. The name of the DICOM store that is being accessed. For example,projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}
. -
locations_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
dicom_stores_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
studies_id
(type:String.t
) - Part ofdicomWebPath
. Required. The path of the SearchForInstancesRequest DICOMweb request. For example,instances
,series/{series_uid}/instances
, orstudies/{study_uid}/instances
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.HttpBody{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_dicom_stores_studies_search_for_series(connection, projects_id, locations_id, datasets_id, dicom_stores_id, studies_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_dicom_stores_studies_search_for_series( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.HttpBody.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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 in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see Search for DICOM data.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. The name of the DICOM store that is being accessed. For example,projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}
. -
locations_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
dicom_stores_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
studies_id
(type:String.t
) - Part ofdicomWebPath
. Required. The path of the SearchForSeries DICOMweb request. For example,series
orstudies/{study_uid}/series
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.HttpBody{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_dicom_stores_studies_series_delete(connection, projects_id, locations_id, datasets_id, dicom_stores_id, studies_id, series_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_dicom_stores_studies_series_delete( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. The name of the DICOM store that is being accessed. For example,projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}
. -
locations_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
dicom_stores_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
studies_id
(type:String.t
) - Part ofdicomWebPath
. Required. The path of the DeleteSeries request. For example,studies/{study_uid}/series/{series_uid}
. -
series_id
(type:String.t
) - Part ofdicomWebPath
. See documentation ofstudiesId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.Operation{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_dicom_stores_studies_series_instances_delete(connection, projects_id, locations_id, datasets_id, dicom_stores_id, studies_id, series_id, instances_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_dicom_stores_studies_series_instances_delete( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. The name of the DICOM store that is being accessed. For example,projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}
. -
locations_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
dicom_stores_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
studies_id
(type:String.t
) - Part ofdicomWebPath
. Required. The path of the DeleteInstance request. For example,studies/{study_uid}/series/{series_uid}/instances/{instance_uid}
. -
series_id
(type:String.t
) - Part ofdicomWebPath
. See documentation ofstudiesId
. -
instances_id
(type:String.t
) - Part ofdicomWebPath
. See documentation ofstudiesId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.Empty{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_dicom_stores_studies_series_instances_frames_retrieve_frames(connection, projects_id, locations_id, datasets_id, dicom_stores_id, studies_id, series_id, instances_id, frames_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_dicom_stores_studies_series_instances_frames_retrieve_frames( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.HttpBody.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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 in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveFrames, see Retrieve DICOM data.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. The name of the DICOM store that is being accessed. For example,projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}
. -
locations_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
dicom_stores_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
studies_id
(type:String.t
) - Part ofdicomWebPath
. Required. The path of the RetrieveFrames DICOMweb request. For example,studies/{study_uid}/series/{series_uid}/instances/{instance_uid}/frames/{frame_list}
. -
series_id
(type:String.t
) - Part ofdicomWebPath
. See documentation ofstudiesId
. -
instances_id
(type:String.t
) - Part ofdicomWebPath
. See documentation ofstudiesId
. -
frames_id
(type:String.t
) - Part ofdicomWebPath
. See documentation ofstudiesId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.HttpBody{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_dicom_stores_studies_series_instances_frames_retrieve_rendered(connection, projects_id, locations_id, datasets_id, dicom_stores_id, studies_id, series_id, instances_id, frames_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_dicom_stores_studies_series_instances_frames_retrieve_rendered( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.HttpBody.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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 in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedFrames, see Retrieve consumer image formats.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. The name of the DICOM store that is being accessed. For example,projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}
. -
locations_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
dicom_stores_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
studies_id
(type:String.t
) - Part ofdicomWebPath
. Required. The path of the RetrieveRenderedFrames DICOMweb request. For example,studies/{study_uid}/series/{series_uid}/instances/{instance_uid}/frames/{frame_list}/rendered
. -
series_id
(type:String.t
) - Part ofdicomWebPath
. See documentation ofstudiesId
. -
instances_id
(type:String.t
) - Part ofdicomWebPath
. See documentation ofstudiesId
. -
frames_id
(type:String.t
) - Part ofdicomWebPath
. See documentation ofstudiesId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.HttpBody{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_dicom_stores_studies_series_instances_retrieve_instance(connection, projects_id, locations_id, datasets_id, dicom_stores_id, studies_id, series_id, instances_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_dicom_stores_studies_series_instances_retrieve_instance( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.HttpBody.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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 and DICOM instances in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstance, see Retrieve an instance.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. The name of the DICOM store that is being accessed. For example,projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}
. -
locations_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
dicom_stores_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
studies_id
(type:String.t
) - Part ofdicomWebPath
. Required. The path of the RetrieveInstance DICOMweb request. For example,studies/{study_uid}/series/{series_uid}/instances/{instance_uid}
. -
series_id
(type:String.t
) - Part ofdicomWebPath
. See documentation ofstudiesId
. -
instances_id
(type:String.t
) - Part ofdicomWebPath
. See documentation ofstudiesId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.HttpBody{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_dicom_stores_studies_series_instances_retrieve_metadata(connection, projects_id, locations_id, datasets_id, dicom_stores_id, studies_id, series_id, instances_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_dicom_stores_studies_series_instances_retrieve_metadata( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.HttpBody.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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 in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstanceMetadata, see Retrieve metadata.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. The name of the DICOM store that is being accessed. For example,projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}
. -
locations_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
dicom_stores_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
studies_id
(type:String.t
) - Part ofdicomWebPath
. Required. The path of the RetrieveInstanceMetadata DICOMweb request. For example,studies/{study_uid}/series/{series_uid}/instances/{instance_uid}/metadata
. -
series_id
(type:String.t
) - Part ofdicomWebPath
. See documentation ofstudiesId
. -
instances_id
(type:String.t
) - Part ofdicomWebPath
. See documentation ofstudiesId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.HttpBody{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_dicom_stores_studies_series_instances_retrieve_rendered(connection, projects_id, locations_id, datasets_id, dicom_stores_id, studies_id, series_id, instances_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_dicom_stores_studies_series_instances_retrieve_rendered( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.HttpBody.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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 in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedInstance, see Retrieve consumer image formats.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. The name of the DICOM store that is being accessed. For example,projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}
. -
locations_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
dicom_stores_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
studies_id
(type:String.t
) - Part ofdicomWebPath
. Required. The path of the RetrieveRenderedInstance DICOMweb request. For example,studies/{study_uid}/series/{series_uid}/instances/{instance_uid}/rendered
. -
series_id
(type:String.t
) - Part ofdicomWebPath
. See documentation ofstudiesId
. -
instances_id
(type:String.t
) - Part ofdicomWebPath
. See documentation ofstudiesId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.HttpBody{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_dicom_stores_studies_series_retrieve_metadata(connection, projects_id, locations_id, datasets_id, dicom_stores_id, studies_id, series_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_dicom_stores_studies_series_retrieve_metadata( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.HttpBody.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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 in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeriesMetadata, see Retrieve metadata.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. The name of the DICOM store that is being accessed. For example,projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}
. -
locations_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
dicom_stores_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
studies_id
(type:String.t
) - Part ofdicomWebPath
. Required. The path of the RetrieveSeriesMetadata DICOMweb request. For example,studies/{study_uid}/series/{series_uid}/metadata
. -
series_id
(type:String.t
) - Part ofdicomWebPath
. See documentation ofstudiesId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.HttpBody{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_dicom_stores_studies_series_retrieve_series(connection, projects_id, locations_id, datasets_id, dicom_stores_id, studies_id, series_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_dicom_stores_studies_series_retrieve_series( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.HttpBody.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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 in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeries, see Retrieve DICOM data.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. The name of the DICOM store that is being accessed. For example,projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}
. -
locations_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
dicom_stores_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
studies_id
(type:String.t
) - Part ofdicomWebPath
. Required. The path of the RetrieveSeries DICOMweb request. For example,studies/{study_uid}/series/{series_uid}
. -
series_id
(type:String.t
) - Part ofdicomWebPath
. See documentation ofstudiesId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.HttpBody{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_dicom_stores_studies_series_search_for_instances(connection, projects_id, locations_id, datasets_id, dicom_stores_id, studies_id, series_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_dicom_stores_studies_series_search_for_instances( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.HttpBody.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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 in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see Search for DICOM data.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. The name of the DICOM store that is being accessed. For example,projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}
. -
locations_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
dicom_stores_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
studies_id
(type:String.t
) - Part ofdicomWebPath
. Required. The path of the SearchForInstancesRequest DICOMweb request. For example,instances
,series/{series_uid}/instances
, orstudies/{study_uid}/instances
. -
series_id
(type:String.t
) - Part ofdicomWebPath
. See documentation ofstudiesId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.HttpBody{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_dicom_stores_studies_store_instances(connection, projects_id, locations_id, datasets_id, dicom_stores_id, studies_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_dicom_stores_studies_store_instances( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.HttpBody.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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 in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see Store DICOM data.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. The name of the DICOM store that is being accessed. For example,projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}
. -
locations_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
dicom_stores_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
studies_id
(type:String.t
) - Part ofdicomWebPath
. Required. The path of the StoreInstances DICOMweb request. For example,studies/[{study_uid}]
. Note that thestudy_uid
is optional. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.HealthCare.V1.Model.HttpBody.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.HttpBody{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_dicom_stores_test_iam_permissions(connection, projects_id, locations_id, datasets_id, dicom_stores_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_dicom_stores_test_iam_permissions( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.TestIamPermissionsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofresource
. REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field. -
locations_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
dicom_stores_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.HealthCare.V1.Model.TestIamPermissionsRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.TestIamPermissionsResponse{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_fhir_stores_create(connection, projects_id, locations_id, datasets_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_fhir_stores_create( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.FhirStore.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a new FHIR store within the parent dataset.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. The name of the dataset this FHIR store belongs to. -
locations_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:fhirStoreId
(type:String.t
) - Required. The ID of the FHIR store that is being created. The string must match the following regex:[\p{L}\p{N}_\-\.]{1,256}
. -
:body
(type:GoogleApi.HealthCare.V1.Model.FhirStore.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.FhirStore{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_fhir_stores_deidentify(connection, projects_id, locations_id, datasets_id, fhir_stores_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_fhir_stores_deidentify( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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).
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofsourceStore
. Required. Source FHIR store resource name. For example,projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}
. -
locations_id
(type:String.t
) - Part ofsourceStore
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofsourceStore
. See documentation ofprojectsId
. -
fhir_stores_id
(type:String.t
) - Part ofsourceStore
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.HealthCare.V1.Model.DeidentifyFhirStoreRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.Operation{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_fhir_stores_delete(connection, projects_id, locations_id, datasets_id, fhir_stores_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_fhir_stores_delete( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes the specified FHIR store and removes all resources within it.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Required. The resource name of the FHIR store to delete. -
locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
fhir_stores_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.Empty{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_fhir_stores_export(connection, projects_id, locations_id, datasets_id, fhir_stores_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_fhir_stores_export( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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). 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.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Required. The name of the FHIR store to export resource from, in the format ofprojects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}
. -
locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
fhir_stores_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.HealthCare.V1.Model.ExportResourcesRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.Operation{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_fhir_stores_fhir__patient_everything(connection, projects_id, locations_id, datasets_id, fhir_stores_id, patient_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_fhir_stores_fhir__patient_everything( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.HttpBody.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Retrieves a Patient resource and resources related to that patient. Implements the FHIR extended operation Patient-everything (DSTU2, STU3, R4). 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, STU3, R4), 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.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Required. Name of thePatient
resource for which the information is required. -
locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
fhir_stores_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
patient_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:_count
(type:integer()
) - Optional. Maximum number of resources in a page. If not specified, 100 is used. May not be larger than 1000. -
:_page_token
(type:String.t
) - 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, wherelink.relation
is "previous" or "next". Omit_page_token
if no previous request has been made. -
:_since
(type:String.t
) - Optional. 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
or2017-01-01T00:00:00Z
. The time must be specified to the second and include a time zone. -
:_type
(type:String.t
) - Optional. 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. -
:end
(type:String.t
) - Optional. 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. -
:start
(type:String.t
) - Optional. 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.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.HttpBody{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_fhir_stores_fhir__resource_purge(connection, projects_id, locations_id, datasets_id, fhir_stores_id, fhir_id, fhir_id1, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_fhir_stores_fhir__resource_purge( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Required. The name of the resource to purge. -
locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
fhir_stores_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
fhir_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
fhir_id1
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.Empty{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_fhir_stores_fhir__resource_validate(connection, projects_id, locations_id, datasets_id, fhir_stores_id, fhir_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_fhir_stores_fhir__resource_validate( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.HttpBody.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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, STU3, or R4). 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.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. The name of the FHIR store that holds the profiles being used for validation. -
locations_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
fhir_stores_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
fhir_id
(type:String.t
) - Part oftype
. Required. The FHIR resource type of the resource being validated. For a complete list, see the FHIR Resource Index (DSTU2, STU3, or R4). Must match the resource type in the provided content. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:profile
(type:String.t
) - 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 behttp://hl7.org/fhir/us/core/StructureDefinition/us-core-patient
. A StructureDefinition with this canonical URL must exist in the FHIR store. -
:body
(type:GoogleApi.HealthCare.V1.Model.HttpBody.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.HttpBody{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_fhir_stores_fhir_capabilities(connection, projects_id, locations_id, datasets_id, fhir_stores_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_fhir_stores_fhir_capabilities( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.HttpBody.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the FHIR capability statement (STU3, R4), or the conformance statement in the DSTU2 case for the store, which contains a description of functionality supported by the server. Implements the FHIR standard capabilities interaction (STU3, R4), or the conformance interaction in the DSTU2 case. On success, the response body contains a JSON-encoded representation of a CapabilityStatement
resource.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Required. Name of the FHIR store to retrieve the capabilities for. -
locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
fhir_stores_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.HttpBody{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_fhir_stores_fhir_conditional_delete(connection, projects_id, locations_id, datasets_id, fhir_stores_id, fhir_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_fhir_stores_fhir_conditional_delete( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. The name of the FHIR store this resource belongs to. -
locations_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
fhir_stores_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
fhir_id
(type:String.t
) - Part oftype
. Required. The FHIR resource type to delete, such as Patient or Observation. For a complete list, see the FHIR Resource Index (DSTU2, STU3, R4). -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.Empty{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_fhir_stores_fhir_conditional_patch(connection, projects_id, locations_id, datasets_id, fhir_stores_id, fhir_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_fhir_stores_fhir_conditional_patch( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.HttpBody.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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 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.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. The name of the FHIR store this resource belongs to. -
locations_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
fhir_stores_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
fhir_id
(type:String.t
) - Part oftype
. Required. The FHIR resource type to update, such as Patient or Observation. For a complete list, see the FHIR Resource Index (DSTU2, STU3, R4). -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.HealthCare.V1.Model.HttpBody.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.HttpBody{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_fhir_stores_fhir_conditional_update(connection, projects_id, locations_id, datasets_id, fhir_stores_id, fhir_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_fhir_stores_fhir_conditional_update( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.HttpBody.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. The name of the FHIR store this resource belongs to. -
locations_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
fhir_stores_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
fhir_id
(type:String.t
) - Part oftype
. Required. The FHIR resource type to update, such as Patient or Observation. For a complete list, see the FHIR Resource Index (DSTU2, STU3, R4). Must match the resource type in the provided content. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.HealthCare.V1.Model.HttpBody.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.HttpBody{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_fhir_stores_fhir_create(connection, projects_id, locations_id, datasets_id, fhir_stores_id, fhir_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_fhir_stores_fhir_create( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.HttpBody.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a FHIR resource. Implements the FHIR standard create interaction (DSTU2, STU3, R4), which creates a new resource with a server-assigned resource ID. Also supports the FHIR standard conditional create interaction (DSTU2, STU3, R4), 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.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. The name of the FHIR store this resource belongs to. -
locations_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
fhir_stores_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
fhir_id
(type:String.t
) - Part oftype
. Required. The FHIR resource type to create, such as Patient or Observation. For a complete list, see the FHIR Resource Index (DSTU2, STU3, R4). Must match the resource type in the provided content. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.HealthCare.V1.Model.HttpBody.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.HttpBody{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_fhir_stores_fhir_delete(connection, projects_id, locations_id, datasets_id, fhir_stores_id, fhir_id, fhir_id1, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_fhir_stores_fhir_delete( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.HttpBody.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes a FHIR resource. Implements the FHIR standard delete interaction (DSTU2, STU3, R4). 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.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Required. The name of the resource to delete. -
locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
fhir_stores_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
fhir_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
fhir_id1
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.HttpBody{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_fhir_stores_fhir_execute_bundle(connection, projects_id, locations_id, datasets_id, fhir_stores_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_fhir_stores_fhir_execute_bundle( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.HttpBody.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Executes all the requests in the given Bundle. Implements the FHIR standard batch/transaction interaction (DSTU2, STU3, R4). 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, STU3, R4) and transaction processing rules (DSTU2, STU3, R4). 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. For samples that show how to call executeBundle
, see Managing FHIR resources using FHIR bundles.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. Name of the FHIR store in which this bundle will be executed. -
locations_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
fhir_stores_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.HealthCare.V1.Model.HttpBody.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.HttpBody{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_fhir_stores_fhir_history(connection, projects_id, locations_id, datasets_id, fhir_stores_id, fhir_id, fhir_id1, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_fhir_stores_fhir_history( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.HttpBody.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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, STU3, R4). 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.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Required. The name of the resource to retrieve. -
locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
fhir_stores_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
fhir_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
fhir_id1
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:_at
(type:String.t
) - 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
-
:_count
(type:integer()
) - The maximum number of search results on a page. If not specified, 100 is used. May not be larger than 1000. -
:_page_token
(type:String.t
) - 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, wherelink.relation
is "previous" or "next". Omit_page_token
if no previous request has been made. -
:_since
(type:String.t
) - 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.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.HttpBody{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_fhir_stores_fhir_patch(connection, projects_id, locations_id, datasets_id, fhir_stores_id, fhir_id, fhir_id1, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_fhir_stores_fhir_patch( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.HttpBody.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates part of an existing resource by applying the operations specified in a JSON Patch document. Implements the FHIR standard patch interaction (STU3, R4). 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.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Required. The name of the resource to update. -
locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
fhir_stores_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
fhir_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
fhir_id1
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.HealthCare.V1.Model.HttpBody.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.HttpBody{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_fhir_stores_fhir_read(connection, projects_id, locations_id, datasets_id, fhir_stores_id, fhir_id, fhir_id1, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_fhir_stores_fhir_read( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.HttpBody.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the contents of a FHIR resource. Implements the FHIR standard read interaction (DSTU2, STU3, R4). Also supports the FHIR standard conditional read interaction (DSTU2, STU3, R4) 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.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Required. The name of the resource to retrieve. -
locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
fhir_stores_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
fhir_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
fhir_id1
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.HttpBody{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_fhir_stores_fhir_search(connection, projects_id, locations_id, datasets_id, fhir_stores_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_fhir_stores_fhir_search( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.HttpBody.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction (DSTU2, STU3, R4) using the search semantics described in the FHIR Search specification (DSTU2, STU3, R4). 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, R4). 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 and Advanced FHIR search features.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. Name of the FHIR store to retrieve resources from. -
locations_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
fhir_stores_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.HealthCare.V1.Model.SearchResourcesRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.HttpBody{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_fhir_stores_fhir_search_type(connection, projects_id, locations_id, datasets_id, fhir_stores_id, resource_type, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_fhir_stores_fhir_search_type( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.HttpBody.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction (DSTU2, STU3, R4) using the search semantics described in the FHIR Search specification (DSTU2, STU3, R4). 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, R4). 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 and Advanced FHIR search features.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. Name of the FHIR store to retrieve resources from. -
locations_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
fhir_stores_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
resource_type
(type:String.t
) - Required. The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index (DSTU2, STU3, R4). -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.HealthCare.V1.Model.SearchResourcesRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.HttpBody{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_fhir_stores_fhir_update(connection, projects_id, locations_id, datasets_id, fhir_stores_id, fhir_id, fhir_id1, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_fhir_stores_fhir_update( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.HttpBody.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates the entire contents of a resource. Implements the FHIR standard update interaction (DSTU2, STU3, R4). 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.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Required. The name of the resource to update. -
locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
fhir_stores_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
fhir_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
fhir_id1
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.HealthCare.V1.Model.HttpBody.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.HttpBody{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_fhir_stores_fhir_vread(connection, projects_id, locations_id, datasets_id, fhir_stores_id, fhir_id, fhir_id1, history_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_fhir_stores_fhir_vread( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.HttpBody.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the contents of a version (current or historical) of a FHIR resource by version ID. Implements the FHIR standard vread interaction (DSTU2, STU3, R4). 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.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Required. The name of the resource version to retrieve. -
locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
fhir_stores_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
fhir_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
fhir_id1
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
_history_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.HttpBody{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_fhir_stores_get(connection, projects_id, locations_id, datasets_id, fhir_stores_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_fhir_stores_get( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.FhirStore.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the configuration of the specified FHIR store.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Required. The resource name of the FHIR store to get. -
locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
fhir_stores_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.FhirStore{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_fhir_stores_get_fhir_store_metrics(connection, projects_id, locations_id, datasets_id, fhir_stores_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_fhir_stores_get_fhir_store_metrics( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.FhirStoreMetrics.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets metrics associated with the FHIR store.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Required. The resource name of the FHIR store to get metrics for. -
locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
fhir_stores_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.FhirStoreMetrics{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_fhir_stores_get_iam_policy(connection, projects_id, locations_id, datasets_id, fhir_stores_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_fhir_stores_get_iam_policy( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofresource
. REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field. -
locations_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
fhir_stores_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:"options.requestedPolicyVersion"
(type:integer()
) - Optional. 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.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.Policy{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_fhir_stores_import(connection, projects_id, locations_id, datasets_id, fhir_stores_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_fhir_stores_import( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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). 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.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Required. The name of the FHIR store to import FHIR resources to, in the format ofprojects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}
. -
locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
fhir_stores_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.HealthCare.V1.Model.ImportResourcesRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.Operation{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_fhir_stores_list(connection, projects_id, locations_id, datasets_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_fhir_stores_list( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.ListFhirStoresResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists the FHIR stores in the given dataset.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. Name of the dataset. -
locations_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter
(type:String.t
) - 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 withgreat
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 theNOT
operator to an expression to negate it. A date field value must be written inyyyy-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 theNOT
operator to an expression to negate it. Multiple field query expressions can be combined in one query by addingAND
orOR
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 theNOT
operator to an expression to negate it. Only filtering on labels is supported, for examplelabels.key=value
. -
:pageSize
(type:integer()
) - 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. -
:pageToken
(type:String.t
) - The next_page_token value returned from the previous List request, if any.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.ListFhirStoresResponse{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_fhir_stores_patch(connection, projects_id, locations_id, datasets_id, fhir_stores_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_fhir_stores_patch( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.FhirStore.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates the configuration of the specified FHIR store.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part offhirStore.name
. Output only. Identifier. Resource name of the FHIR store, of the formprojects/{project_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}
. -
locations_id
(type:String.t
) - Part offhirStore.name
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part offhirStore.name
. See documentation ofprojectsId
. -
fhir_stores_id
(type:String.t
) - Part offhirStore.name
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:updateMask
(type:String.t
) - Required. The update mask applies to the resource. For theFieldMask
definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask -
:body
(type:GoogleApi.HealthCare.V1.Model.FhirStore.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.FhirStore{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_fhir_stores_rollback(connection, projects_id, locations_id, datasets_id, fhir_stores_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_fhir_stores_rollback( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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). 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.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Required. 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}". -
locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
fhir_stores_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.HealthCare.V1.Model.RollbackFhirResourcesRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.Operation{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_fhir_stores_set_iam_policy(connection, projects_id, locations_id, datasets_id, fhir_stores_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_fhir_stores_set_iam_policy( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofresource
. REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field. -
locations_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
fhir_stores_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.HealthCare.V1.Model.SetIamPolicyRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.Policy{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_fhir_stores_test_iam_permissions(connection, projects_id, locations_id, datasets_id, fhir_stores_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_fhir_stores_test_iam_permissions( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.TestIamPermissionsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofresource
. REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field. -
locations_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
fhir_stores_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.HealthCare.V1.Model.TestIamPermissionsRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.TestIamPermissionsResponse{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_get(connection, projects_id, locations_id, datasets_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_get( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.Dataset.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets any metadata associated with a dataset.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Required. The name of the dataset to read. For example,projects/{project_id}/locations/{location_id}/datasets/{dataset_id}
. -
locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.Dataset{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_get_iam_policy(connection, projects_id, locations_id, datasets_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_get_iam_policy( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofresource
. REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field. -
locations_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:"options.requestedPolicyVersion"
(type:integer()
) - Optional. 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.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.Policy{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_hl7_v2_stores_create(connection, projects_id, locations_id, datasets_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_hl7_v2_stores_create( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.Hl7V2Store.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a new HL7v2 store within the parent dataset.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. The name of the dataset this HL7v2 store belongs to. -
locations_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:hl7V2StoreId
(type:String.t
) - Required. The ID of the HL7v2 store that is being created. The string must match the following regex:[\p{L}\p{N}_\-\.]{1,256}
. -
:body
(type:GoogleApi.HealthCare.V1.Model.Hl7V2Store.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.Hl7V2Store{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_hl7_v2_stores_delete(connection, projects_id, locations_id, datasets_id, hl7_v2_stores_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_hl7_v2_stores_delete( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes the specified HL7v2 store and removes all messages that it contains.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Required. The resource name of the HL7v2 store to delete. -
locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
hl7_v2_stores_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.Empty{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_hl7_v2_stores_export(connection, projects_id, locations_id, datasets_id, hl7_v2_stores_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_hl7_v2_stores_export( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Required. The name of the source HL7v2 store, in the formatprojects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7v2Stores/{hl7v2_store_id}
-
locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
hl7_v2_stores_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.HealthCare.V1.Model.ExportMessagesRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.Operation{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_hl7_v2_stores_get(connection, projects_id, locations_id, datasets_id, hl7_v2_stores_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_hl7_v2_stores_get( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.Hl7V2Store.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the specified HL7v2 store.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Required. The resource name of the HL7v2 store to get. -
locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
hl7_v2_stores_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.Hl7V2Store{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_hl7_v2_stores_get_hl7v2_store_metrics(connection, projects_id, locations_id, datasets_id, hl7_v2_stores_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_hl7_v2_stores_get_hl7v2_store_metrics( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.Hl7V2StoreMetrics.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets metrics associated with the HL7v2 store.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Required. The resource name of the HL7v2 store to get metrics for, in the formatprojects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}
. -
locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
hl7_v2_stores_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.Hl7V2StoreMetrics{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_hl7_v2_stores_get_iam_policy(connection, projects_id, locations_id, datasets_id, hl7_v2_stores_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_hl7_v2_stores_get_iam_policy( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofresource
. REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field. -
locations_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
hl7_v2_stores_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:"options.requestedPolicyVersion"
(type:integer()
) - Optional. 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.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.Policy{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_hl7_v2_stores_import(connection, projects_id, locations_id, datasets_id, hl7_v2_stores_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_hl7_v2_stores_import( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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). 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.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Required. The name of the target HL7v2 store, in the formatprojects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7v2Stores/{hl7v2_store_id}
-
locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
hl7_v2_stores_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.HealthCare.V1.Model.ImportMessagesRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.Operation{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_hl7_v2_stores_list(connection, projects_id, locations_id, datasets_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_hl7_v2_stores_list( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.ListHl7V2StoresResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists the HL7v2 stores in the given dataset.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. Name of the dataset. -
locations_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter
(type:String.t
) - 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 withgreat
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 theNOT
operator to an expression to negate it. A date field value must be written inyyyy-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 theNOT
operator to an expression to negate it. Multiple field query expressions can be combined in one query by addingAND
orOR
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 theNOT
operator to an expression to negate it. Only filtering on labels is supported. For example,labels.key=value
. -
:pageSize
(type:integer()
) - 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. -
:pageToken
(type:String.t
) - The next_page_token value returned from the previous List request, if any.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.ListHl7V2StoresResponse{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_hl7_v2_stores_messages_create(connection, projects_id, locations_id, datasets_id, hl7_v2_stores_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_hl7_v2_stores_messages_create( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.Message.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. The name of the HL7v2 store this message belongs to. -
locations_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
hl7_v2_stores_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.HealthCare.V1.Model.CreateMessageRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.Message{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_hl7_v2_stores_messages_delete(connection, projects_id, locations_id, datasets_id, hl7_v2_stores_id, messages_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_hl7_v2_stores_messages_delete( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes an HL7v2 message.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Required. The resource name of the HL7v2 message to delete. -
locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
hl7_v2_stores_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
messages_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.Empty{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_hl7_v2_stores_messages_get(connection, projects_id, locations_id, datasets_id, hl7_v2_stores_id, messages_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_hl7_v2_stores_messages_get( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.Message.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets an HL7v2 message.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Required. The resource name of the HL7v2 message to retrieve. -
locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
hl7_v2_stores_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
messages_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:view
(type:String.t
) - Specifies which parts of the Message resource to return in the response. When unspecified, equivalent to FULL.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.Message{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_hl7_v2_stores_messages_ingest(connection, projects_id, locations_id, datasets_id, hl7_v2_stores_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_hl7_v2_stores_messages_ingest( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.IngestMessageResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. The name of the HL7v2 store this message belongs to. -
locations_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
hl7_v2_stores_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.HealthCare.V1.Model.IngestMessageRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.IngestMessageResponse{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_hl7_v2_stores_messages_list(connection, projects_id, locations_id, datasets_id, hl7_v2_stores_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_hl7_v2_stores_messages_list( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.ListMessagesResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. Name of the HL7v2 store to retrieve messages from. -
locations_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
hl7_v2_stores_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter
(type:String.t
) - 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 withgreat
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 theNOT
operator to an expression to negate it. A date field value must be written inyyyy-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 theNOT
operator to an expression to negate it. Multiple field query expressions can be combined in one query by addingAND
orOR
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 theNOT
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
orsendDate
, 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 keyx
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":*`. -
:orderBy
(type:String.t
) - 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
-
:pageSize
(type:integer()
) - Limit on the number of messages to return in a single response. If not specified, 100 is used. May not be larger than 1000. -
:pageToken
(type:String.t
) - The next_page_token value returned from the previous List request, if any. -
:view
(type:String.t
) - Specifies the parts of the Message to return in the response. When unspecified, equivalent to BASIC. Setting this to anything other than BASIC with apage_size
larger than the default can generate a large response, which impacts the performance of this method.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.ListMessagesResponse{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_hl7_v2_stores_messages_patch(connection, projects_id, locations_id, datasets_id, hl7_v2_stores_id, messages_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_hl7_v2_stores_messages_patch( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.Message.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofmessage.name
. Output only. Resource name of the Message, of the formprojects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}
. Assigned by the server. -
locations_id
(type:String.t
) - Part ofmessage.name
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofmessage.name
. See documentation ofprojectsId
. -
hl7_v2_stores_id
(type:String.t
) - Part ofmessage.name
. See documentation ofprojectsId
. -
messages_id
(type:String.t
) - Part ofmessage.name
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:updateMask
(type:String.t
) - Required. The update mask applies to the resource. For theFieldMask
definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask -
:body
(type:GoogleApi.HealthCare.V1.Model.Message.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.Message{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_hl7_v2_stores_patch(connection, projects_id, locations_id, datasets_id, hl7_v2_stores_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_hl7_v2_stores_patch( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.Hl7V2Store.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates the HL7v2 store.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofhl7V2Store.name
. Identifier. Resource name of the HL7v2 store, of the formprojects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}
. -
locations_id
(type:String.t
) - Part ofhl7V2Store.name
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofhl7V2Store.name
. See documentation ofprojectsId
. -
hl7_v2_stores_id
(type:String.t
) - Part ofhl7V2Store.name
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:updateMask
(type:String.t
) - Required. The update mask applies to the resource. For theFieldMask
definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask -
:body
(type:GoogleApi.HealthCare.V1.Model.Hl7V2Store.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.Hl7V2Store{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_hl7_v2_stores_set_iam_policy(connection, projects_id, locations_id, datasets_id, hl7_v2_stores_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_hl7_v2_stores_set_iam_policy( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofresource
. REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field. -
locations_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
hl7_v2_stores_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.HealthCare.V1.Model.SetIamPolicyRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.Policy{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_hl7_v2_stores_test_iam_permissions(connection, projects_id, locations_id, datasets_id, hl7_v2_stores_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_hl7_v2_stores_test_iam_permissions( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.TestIamPermissionsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofresource
. REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field. -
locations_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
hl7_v2_stores_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.HealthCare.V1.Model.TestIamPermissionsRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.TestIamPermissionsResponse{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_list(connection, projects_id, locations_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_list( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.ListDatasetsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists the health datasets in the current project.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. The name of the project whose datasets should be listed. For example,projects/{project_id}/locations/{location_id}
. -
locations_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:pageSize
(type:integer()
) - The maximum number of items to return. If not specified, 100 is used. May not be larger than 1000. -
:pageToken
(type:String.t
) - The next_page_token value returned from a previous List request, if any.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.ListDatasetsResponse{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_operations_cancel(connection, projects_id, locations_id, datasets_id, operations_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_operations_cancel( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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
.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. The name of the operation resource to be cancelled. -
locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
operations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.HealthCare.V1.Model.CancelOperationRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.Empty{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_operations_get(connection, projects_id, locations_id, datasets_id, operations_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_operations_get( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. The name of the operation resource. -
locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
operations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.Operation{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_operations_list(connection, projects_id, locations_id, datasets_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_operations_list( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.ListOperationsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. The name of the operation's parent resource. -
locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter
(type:String.t
) - The standard list filter. -
:pageSize
(type:integer()
) - The standard list page size. -
:pageToken
(type:String.t
) - The standard list page token.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.ListOperationsResponse{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_patch(connection, projects_id, locations_id, datasets_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_patch( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.Dataset.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates dataset metadata.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofdataset.name
. Identifier. Resource name of the dataset, of the formprojects/{project_id}/locations/{location_id}/datasets/{dataset_id}
. -
locations_id
(type:String.t
) - Part ofdataset.name
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofdataset.name
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:updateMask
(type:String.t
) - Required. The update mask applies to the resource. For theFieldMask
definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask -
:body
(type:GoogleApi.HealthCare.V1.Model.Dataset.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.Dataset{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_set_iam_policy(connection, projects_id, locations_id, datasets_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_set_iam_policy( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofresource
. REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field. -
locations_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.HealthCare.V1.Model.SetIamPolicyRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.Policy{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_datasets_test_iam_permissions(connection, projects_id, locations_id, datasets_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_datasets_test_iam_permissions( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.TestIamPermissionsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofresource
. REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field. -
locations_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.HealthCare.V1.Model.TestIamPermissionsRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.TestIamPermissionsResponse{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_get(connection, projects_id, locations_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_get( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.Location.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets information about a location.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Resource name for the location. -
locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.Location{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_list(connection, projects_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.ListLocationsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists information about the supported locations for this service.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. The resource that owns the locations collection, if applicable. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter
(type:String.t
) - 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. -
:pageSize
(type:integer()
) - The maximum number of results to return. If not set, the service selects a default. -
:pageToken
(type:String.t
) - A page token received from thenext_page_token
field in the response. Send that page token to receive the subsequent page.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.ListLocationsResponse{}}
on success -
{:error, info}
on failure
healthcare_projects_locations_services_nlp_analyze_entities(connection, projects_id, locations_id, optional_params \\ [], opts \\ [])
View Source@spec healthcare_projects_locations_services_nlp_analyze_entities( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1.Model.AnalyzeEntitiesResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofnlpService
. The resource name of the service of the form: "projects/{project_id}/locations/{location_id}/services/nlp". -
locations_id
(type:String.t
) - Part ofnlpService
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.HealthCare.V1.Model.AnalyzeEntitiesRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1.Model.AnalyzeEntitiesResponse{}}
on success -
{:error, info}
on failure