{ "opencollection": "1.0.0", "info": { "name": "Cloud Healthcare projects API", "version": "v1" }, "items": [ { "info": { "name": "projects", "type": "folder" }, "items": [ { "info": { "name": "healthcare.projects.locations.datasets.consentStores.checkDataAccess", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1/:consentStore:checkDataAccess", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "consentStore", "value": "", "type": "path", "description": "Required. Name of the consent store where the requested data_id is stored, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}`." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Checks if a particular data_id of a User data mapping in the specified consent store is consented for the specified use." }, { "info": { "name": "healthcare.projects.locations.datasets.consentStores.evaluateUserConsents", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1/:consentStore:evaluateUserConsents", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "consentStore", "value": "", "type": "path", "description": "Required. Name of the consent store to retrieve User data mappings from." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "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." }, { "info": { "name": "healthcare.projects.locations.datasets.consentStores.queryAccessibleData", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1/:consentStore:queryAccessibleData", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "consentStore", "value": "", "type": "path", "description": "Required. Name of the consent store to retrieve User data mappings from." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "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 C" }, { "info": { "name": "healthcare.projects.locations.datasets.operations.get", "type": "http" }, "http": { "method": "GET", "url": "https://healthcare.googleapis.com/v1/:name", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "name", "value": "", "type": "path", "description": "The name of the operation resource." }, { "name": "view", "value": "", "type": "query", "description": "Specifies which parts of the Message resource to return in the response. When unspecified, equivalent to FULL." } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "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." }, { "info": { "name": "healthcare.projects.locations.datasets.fhirStores.fhir.update", "type": "http" }, "http": { "method": "PUT", "url": "https://healthcare.googleapis.com/v1/:name", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "name", "value": "", "type": "path", "description": "Required. The name of the resource to update." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Updates the entire contents of a resource. Implements the FHIR standard update interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#update), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#update), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#update)). If the specified resource does not exist and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. It is strongly advised not to include or encode any sen" }, { "info": { "name": "healthcare.projects.locations.datasets.hl7V2Stores.messages.patch", "type": "http" }, "http": { "method": "PATCH", "url": "https://healthcare.googleapis.com/v1/:name", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "name", "value": "", "type": "path", "description": "Output only. Resource name of the Message, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. Assigned by the server." }, { "name": "updateMask", "value": "", "type": "query", "description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "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." }, { "info": { "name": "healthcare.projects.locations.datasets.hl7V2Stores.messages.delete", "type": "http" }, "http": { "method": "DELETE", "url": "https://healthcare.googleapis.com/v1/:name", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "name", "value": "", "type": "path", "description": "Required. The resource name of the HL7v2 message to delete." } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Deletes an HL7v2 message." }, { "info": { "name": "healthcare.projects.locations.datasets.fhirStores.fhir.Patient-everything", "type": "http" }, "http": { "method": "GET", "url": "https://healthcare.googleapis.com/v1/:name/$everything", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "name", "value": "", "type": "path", "description": "Required. Name of the `Patient` resource for which the information is required." }, { "name": "_count", "value": "", "type": "query", "description": "Optional. Maximum number of resources in a page. If not specified, 100 is used. May not be larger than 1000." }, { "name": "_page_token", "value": "", "type": "query", "description": "Used to retrieve the next or previous page of results when using pagination. Set `_page_token` to the value of _page_token set in next or previous page links' url. Next and previous page are returned in the response bundle's links field, where `link.relation` is \"previous\" or \"next\". Omit `_page_token` if no previous request has been made." }, { "name": "_since", "value": "", "type": "query", "description": "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` or `2017-01-01T00:00:00Z`. The time must be specified to the second and include a time zone." }, { "name": "_type", "value": "", "type": "query", "description": "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." }, { "name": "end", "value": "", "type": "query", "description": "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." }, { "name": "start", "value": "", "type": "query", "description": "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." } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Retrieves a Patient resource and resources related to that patient. Implements the FHIR extended operation Patient-everything ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/patient-operations.html#everything), [STU3](http://hl7.org/implement/standards/fhir/STU3/patient-operations.html#everything), [R4](http://hl7.org/implement/standards/fhir/R4/patient-operations.html#everything)). On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `search" }, { "info": { "name": "healthcare.projects.locations.datasets.fhirStores.fhir.Resource-purge", "type": "http" }, "http": { "method": "DELETE", "url": "https://healthcare.googleapis.com/v1/:name/$purge", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "name", "value": "", "type": "path", "description": "Required. The name of the resource to purge." } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Deletes all the historical versions of a resource (excluding the current version) from the FHIR store. To remove all versions of a resource, first delete the current version and then call this method. This is not a FHIR standard operation. For samples that show how to call `Resource-purge`, see [Deleting historical versions of a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#deleting_historical_versions_of_a_fhir_resource)." }, { "info": { "name": "healthcare.projects.locations.datasets.fhirStores.fhir.history", "type": "http" }, "http": { "method": "GET", "url": "https://healthcare.googleapis.com/v1/:name/_history", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "name", "value": "", "type": "path", "description": "Required. The name of the resource to retrieve." }, { "name": "_at", "value": "", "type": "query", "description": "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`" }, { "name": "_count", "value": "", "type": "query", "description": "The maximum number of search results on a page. If not specified, 100 is used. May not be larger than 1000." }, { "name": "_page_token", "value": "", "type": "query", "description": "Used to retrieve the first, previous, next, or last page of resource versions when using pagination. Value should be set to the value of `_page_token` set in next or previous page links' URLs. Next and previous page are returned in the response bundle's links field, where `link.relation` is \"previous\" or \"next\". Omit `_page_token` if no previous request has been made." }, { "name": "_since", "value": "", "type": "query", "description": "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." } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Lists all the versions of a resource (including the current version and deleted versions) from the FHIR store. Implements the per-resource form of the FHIR standard history interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#history), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#history), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#history)). On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type" }, { "info": { "name": "healthcare.projects.locations.datasets.fhirStores.fhir.capabilities", "type": "http" }, "http": { "method": "GET", "url": "https://healthcare.googleapis.com/v1/:name/fhir/metadata", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "name", "value": "", "type": "path", "description": "Required. Name of the FHIR store to retrieve the capabilities for." } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Gets the FHIR capability statement ([STU3](http://hl7.org/implement/standards/fhir/STU3/capabilitystatement.html), [R4](http://hl7.org/implement/standards/fhir/R4/capabilitystatement.html)), or the [conformance statement](http://hl7.org/implement/standards/fhir/DSTU2/conformance.html) in the DSTU2 case for the store, which contains a description of functionality supported by the server. Implements the FHIR standard capabilities interaction ([STU3](http://hl7.org/implement/standards/fhir/STU3/htt" }, { "info": { "name": "healthcare.projects.locations.list", "type": "http" }, "http": { "method": "GET", "url": "https://healthcare.googleapis.com/v1/:name/locations", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "name", "value": "", "type": "path", "description": "The resource that owns the locations collection, if applicable." }, { "name": "filter", "value": "", "type": "query", "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160)." }, { "name": "pageSize", "value": "", "type": "query", "description": "The maximum number of results to return. If not set, the service selects a default." }, { "name": "pageToken", "value": "", "type": "query", "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page." } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Lists information about the supported locations for this service." }, { "info": { "name": "healthcare.projects.locations.datasets.operations.list", "type": "http" }, "http": { "method": "GET", "url": "https://healthcare.googleapis.com/v1/:name/operations", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "name", "value": "", "type": "path", "description": "The name of the operation's parent resource." }, { "name": "filter", "value": "", "type": "query", "description": "The standard list filter." }, { "name": "pageSize", "value": "", "type": "query", "description": "The standard list page size." }, { "name": "pageToken", "value": "", "type": "query", "description": "The standard list page token." } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`." }, { "info": { "name": "healthcare.projects.locations.datasets.consentStores.consents.activate", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1/:name:activate", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "name", "value": "", "type": "path", "description": "Required. The resource name of the Consent to activate, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}`. An INVALID_ARGUMENT error occurs if `revision_id` is specified in the name." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "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." }, { "info": { "name": "healthcare.projects.locations.datasets.consentStores.userDataMappings.archive", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1/:name:archive", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "name", "value": "", "type": "path", "description": "Required. The resource name of the User data mapping to archive." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Archives the specified User data mapping." }, { "info": { "name": "healthcare.projects.locations.datasets.operations.cancel", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1/:name:cancel", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "name", "value": "", "type": "path", "description": "The name of the operation resource to be cancelled." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "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 Operati" }, { "info": { "name": "healthcare.projects.locations.datasets.consentStores.consents.deleteRevision", "type": "http" }, "http": { "method": "DELETE", "url": "https://healthcare.googleapis.com/v1/:name:deleteRevision", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "name", "value": "", "type": "path", "description": "Required. The resource name of the Consent revision to delete, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}@{revision_id}`. An INVALID_ARGUMENT error occurs if `revision_id` is not specified in the name." } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Deletes the specified revision of a Consent. An INVALID_ARGUMENT error occurs if the specified revision is the latest revision." }, { "info": { "name": "healthcare.projects.locations.datasets.hl7V2Stores.export", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1/:name:export", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "name", "value": "", "type": "path", "description": "Required. The name of the source HL7v2 store, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7v2Stores/{hl7v2_store_id}`" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "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 Operat" }, { "info": { "name": "healthcare.projects.locations.datasets.dicomStores.getDICOMStoreMetrics", "type": "http" }, "http": { "method": "GET", "url": "https://healthcare.googleapis.com/v1/:name:getDICOMStoreMetrics", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "name", "value": "", "type": "path", "description": "Required. The resource name of the DICOM store to get metrics for." } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Gets metrics associated with the DICOM store." }, { "info": { "name": "healthcare.projects.locations.datasets.fhirStores.getFHIRStoreMetrics", "type": "http" }, "http": { "method": "GET", "url": "https://healthcare.googleapis.com/v1/:name:getFHIRStoreMetrics", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "name", "value": "", "type": "path", "description": "Required. The resource name of the FHIR store to get metrics for." } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Gets metrics associated with the FHIR store." }, { "info": { "name": "healthcare.projects.locations.datasets.hl7V2Stores.getHL7v2StoreMetrics", "type": "http" }, "http": { "method": "GET", "url": "https://healthcare.googleapis.com/v1/:name:getHL7v2StoreMetrics", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "name", "value": "", "type": "path", "description": "Required. The resource name of the HL7v2 store to get metrics for, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`." } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Gets metrics associated with the HL7v2 store." }, { "info": { "name": "healthcare.projects.locations.datasets.hl7V2Stores.import", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1/:name:import", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "name", "value": "", "type": "path", "description": "Required. The name of the target HL7v2 store, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7v2Stores/{hl7v2_store_id}`" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "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 messag" }, { "info": { "name": "healthcare.projects.locations.datasets.consentStores.consents.listRevisions", "type": "http" }, "http": { "method": "GET", "url": "https://healthcare.googleapis.com/v1/:name:listRevisions", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "name", "value": "", "type": "path", "description": "Required. The resource name of the Consent to retrieve revisions for." }, { "name": "filter", "value": "", "type": "query", "description": "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 with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. Fields available for filtering are: - user_id. For example, `filter='user_id=\"user123\"'`. - consent_artifact - state - revision_create_time - metadata. For example, `filter=Metadata(\\\"testkey\\\")=\\\"value\\\"` or `filter=HasMetadata(\\\"testkey\\\")`." }, { "name": "pageSize", "value": "", "type": "query", "description": "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." }, { "name": "pageToken", "value": "", "type": "query", "description": "Optional. Token to retrieve the next page of results or empty if there are no more results in the list." } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Lists the revisions of the specified Consent in reverse chronological order." }, { "info": { "name": "healthcare.projects.locations.datasets.consentStores.consents.reject", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1/:name:reject", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "name", "value": "", "type": "path", "description": "Required. The resource name of the Consent to reject, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}`. An INVALID_ARGUMENT error occurs if `revision_id` is specified in the name." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "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." }, { "info": { "name": "healthcare.projects.locations.datasets.consentStores.consents.revoke", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1/:name:revoke", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "name", "value": "", "type": "path", "description": "Required. The resource name of the Consent to revoke, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}`. An INVALID_ARGUMENT error occurs if `revision_id` is specified in the name." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "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." }, { "info": { "name": "healthcare.projects.locations.datasets.fhirStores.rollback", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1/:name:rollback", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "name", "value": "", "type": "path", "description": "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}\"." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Rolls back resources from the FHIR store to the specified time. This method returns an Operation that can be used to track the status of the rollback by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). Otherwise, when the operation finishes, a detailed response of type RollbackFhirResourcesResponse is returned in the response field." }, { "info": { "name": "healthcare.projects.locations.services.nlp.analyzeEntities", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1/:nlpService:analyzeEntities", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "nlpService", "value": "", "type": "path", "description": "The resource name of the service of the form: \"projects/{project_id}/locations/{location_id}/services/nlp\"." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "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." }, { "info": { "name": "healthcare.projects.locations.datasets.consentStores.attributeDefinitions.list", "type": "http" }, "http": { "method": "GET", "url": "https://healthcare.googleapis.com/v1/:parent/attributeDefinitions", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "Required. Name of the consent store to retrieve Attribute definitions from." }, { "name": "filter", "value": "", "type": "query", "description": "Optional. Restricts the attributes returned to those matching a filter. The only field available for filtering is `category`. For example, `filter=category=\\\"REQUEST\\\"`." }, { "name": "pageSize", "value": "", "type": "query", "description": "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." }, { "name": "pageToken", "value": "", "type": "query", "description": "Optional. Token to retrieve the next page of results or empty to get the first page." } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Lists the Attribute definitions in the specified consent store." }, { "info": { "name": "healthcare.projects.locations.datasets.consentStores.attributeDefinitions.create", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1/:parent/attributeDefinitions", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "Required. The name of the consent store that this Attribute definition belongs to." }, { "name": "attributeDefinitionId", "value": "", "type": "query", "description": "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": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Creates a new Attribute definition in the parent consent store." }, { "info": { "name": "healthcare.projects.locations.datasets.consentStores.consentArtifacts.list", "type": "http" }, "http": { "method": "GET", "url": "https://healthcare.googleapis.com/v1/:parent/consentArtifacts", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "Required. Name of the consent store to retrieve consent artifacts from." }, { "name": "filter", "value": "", "type": "query", "description": "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 with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. The fields available for filtering are: - user_id. For example, `filter=user_id=\\\"user123\\\"`. - consent_content_version - metadata. For example, `filter=Metadata(\\\"testkey\\\")=\\\"value\\\"` or `filter=HasMetadata(\\\"testkey\\\")`." }, { "name": "pageSize", "value": "", "type": "query", "description": "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." }, { "name": "pageToken", "value": "", "type": "query", "description": "Optional. The next_page_token value returned from the previous List request, if any." } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Lists the Consent artifacts in the specified consent store." }, { "info": { "name": "healthcare.projects.locations.datasets.consentStores.consentArtifacts.create", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1/:parent/consentArtifacts", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "Required. The name of the consent store this Consent artifact belongs to." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Creates a new Consent artifact in the parent consent store." }, { "info": { "name": "healthcare.projects.locations.datasets.consentStores.list", "type": "http" }, "http": { "method": "GET", "url": "https://healthcare.googleapis.com/v1/:parent/consentStores", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "Required. Name of the dataset." }, { "name": "filter", "value": "", "type": "query", "description": "Optional. Restricts the stores returned to those matching a filter. Only filtering on labels is supported. For example, `filter=labels.key=value`." }, { "name": "pageSize", "value": "", "type": "query", "description": "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." }, { "name": "pageToken", "value": "", "type": "query", "description": "Optional. Token to retrieve the next page of results, or empty to get the first page." } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Lists the consent stores in the specified dataset." }, { "info": { "name": "healthcare.projects.locations.datasets.consentStores.create", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1/:parent/consentStores", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "Required. The name of the dataset this consent store belongs to." }, { "name": "consentStoreId", "value": "", "type": "query", "description": "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": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "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." }, { "info": { "name": "healthcare.projects.locations.datasets.consentStores.consents.list", "type": "http" }, "http": { "method": "GET", "url": "https://healthcare.googleapis.com/v1/:parent/consents", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "Required. Name of the consent store to retrieve Consents from." }, { "name": "filter", "value": "", "type": "query", "description": "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 with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. The fields available for filtering are: - user_id. For example, `filter='user_id=\"user123\"'`. - consent_artifact - state - revision_create_time - metadata. For example, `filter=Metadata(\\\"testkey\\\")=\\\"value\\\"` or `filter=HasMetadata(\\\"testkey\\\")`." }, { "name": "pageSize", "value": "", "type": "query", "description": "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." }, { "name": "pageToken", "value": "", "type": "query", "description": "Optional. The next_page_token value returned from the previous List request, if any." } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Lists the Consent in the given consent store, returning each Consent's latest revision." }, { "info": { "name": "healthcare.projects.locations.datasets.consentStores.consents.create", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1/:parent/consents", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "Required. Name of the consent store." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Creates a new Consent in the parent consent store." }, { "info": { "name": "healthcare.projects.locations.datasets.list", "type": "http" }, "http": { "method": "GET", "url": "https://healthcare.googleapis.com/v1/:parent/datasets", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "Required. The name of the project whose datasets should be listed. For example, `projects/{project_id}/locations/{location_id}`." }, { "name": "pageSize", "value": "", "type": "query", "description": "The maximum number of items to return. If not specified, 100 is used. May not be larger than 1000." }, { "name": "pageToken", "value": "", "type": "query", "description": "The next_page_token value returned from a previous List request, if any." } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Lists the health datasets in the current project." }, { "info": { "name": "healthcare.projects.locations.datasets.create", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1/:parent/datasets", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "Required. The name of the project where the server creates the dataset. For example, `projects/{project_id}/locations/{location_id}`." }, { "name": "datasetId", "value": "", "type": "query", "description": "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": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "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." }, { "info": { "name": "healthcare.projects.locations.datasets.dicomStores.list", "type": "http" }, "http": { "method": "GET", "url": "https://healthcare.googleapis.com/v1/:parent/dicomStores", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "Required. Name of the dataset." }, { "name": "filter", "value": "", "type": "query", "description": "Restricts stores returned to those matching a filter. The following syntax is available: * A string field value can be written as text inside quotation marks, for example `\"query text\"`. The only valid relational operation for text fields is equality (`=`), where text is searched within the field, rather than having the field be equal to the text. For example, `\"Comment = great\"` returns messages with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. Only filtering on labels is supported. For example, `labels.key=value`." }, { "name": "pageSize", "value": "", "type": "query", "description": "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." }, { "name": "pageToken", "value": "", "type": "query", "description": "The next_page_token value returned from the previous List request, if any." } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Lists the DICOM stores in the given dataset." }, { "info": { "name": "healthcare.projects.locations.datasets.dicomStores.create", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1/:parent/dicomStores", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "Required. The name of the dataset this DICOM store belongs to." }, { "name": "dicomStoreId", "value": "", "type": "query", "description": "Required. The ID of the DICOM store that is being created. Any string value up to 256 characters in length." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Creates a new DICOM store within the parent dataset." }, { "info": { "name": "healthcare.projects.locations.datasets.dicomStores.studies.series.instances.frames.retrieveRendered", "type": "http" }, "http": { "method": "GET", "url": "https://healthcare.googleapis.com/v1/:parent/dicomWeb/:dicomWebPath", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "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}`." }, { "name": "dicomWebPath", "value": "", "type": "path", "description": "Required. The path of the RetrieveRenderedFrames DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}/frames/{frame_list}/rendered`." } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "RetrieveRenderedFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers in an acceptable Rendered Media Type. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedFrames, see [Rendered resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call " }, { "info": { "name": "healthcare.projects.locations.datasets.dicomStores.studies.storeInstances", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1/:parent/dicomWeb/:dicomWebPath", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "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}`." }, { "name": "dicomWebPath", "value": "", "type": "path", "description": "Required. The path of the StoreInstances DICOMweb request. For example, `studies/[{study_uid}]`. Note that the `study_uid` is optional." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). For details on the implementation of StoreInstances, see [Store transaction](https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see [Store DICOM data](https://cloud.google.com/healthc" }, { "info": { "name": "healthcare.projects.locations.datasets.dicomStores.studies.series.instances.delete", "type": "http" }, "http": { "method": "DELETE", "url": "https://healthcare.googleapis.com/v1/:parent/dicomWeb/:dicomWebPath", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "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}`." }, { "name": "dicomWebPath", "value": "", "type": "path", "description": "Required. The path of the DeleteInstance request. For example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}`." } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "DeleteInstance deletes an instance associated with the given study, series, and SOP Instance UID. Delete requests are equivalent to the GET requests specified in the Retrieve transaction. Study and series search results can take a few seconds to be updated after an instance is deleted using DeleteInstance. For samples that show how to call DeleteInstance, see [Delete a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#delete-dicom)." }, { "info": { "name": "healthcare.projects.locations.datasets.fhirStores.fhir.executeBundle", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1/:parent/fhir", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "Required. Name of the FHIR store in which this bundle will be executed." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Executes all the requests in the given Bundle. Implements the FHIR standard batch/transaction interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#transaction), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#transaction), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#transaction)). Supports all interactions within a bundle, except search. This method accepts Bundles of type `batch` and `transaction`, processing them according to the batch pro" }, { "info": { "name": "healthcare.projects.locations.datasets.fhirStores.fhir.search", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1/:parent/fhir/_search", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "Required. Name of the FHIR store to retrieve resources from." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#search), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#search), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/search.html), [" }, { "info": { "name": "healthcare.projects.locations.datasets.fhirStores.fhir.search-type", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1/:parent/fhir/:resourceType/_search", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "Required. Name of the FHIR store to retrieve resources from." }, { "name": "resourceType", "value": "", "type": "path", "description": "Required. The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html))." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#search), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#search), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/search.html), [" }, { "info": { "name": "healthcare.projects.locations.datasets.fhirStores.fhir.create", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1/:parent/fhir/:type", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "Required. The name of the FHIR store this resource belongs to." }, { "name": "type", "value": "", "type": "path", "description": "Required. The FHIR resource type to create, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html)). Must match the resource type in the provided content." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Creates a FHIR resource. Implements the FHIR standard create interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#create), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#create), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#create)), which creates a new resource with a server-assigned resource ID. Also supports the FHIR standard conditional create interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#ccreate), [STU3](htt" }, { "info": { "name": "healthcare.projects.locations.datasets.fhirStores.fhir.conditionalUpdate", "type": "http" }, "http": { "method": "PUT", "url": "https://healthcare.googleapis.com/v1/:parent/fhir/:type", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "Required. The name of the FHIR store this resource belongs to." }, { "name": "type", "value": "", "type": "path", "description": "Required. The FHIR resource type to update, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/standards/fhir/R4/resourcelist.html)). Must match the resource type in the provided content." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "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 Fai" }, { "info": { "name": "healthcare.projects.locations.datasets.fhirStores.fhir.conditionalPatch", "type": "http" }, "http": { "method": "PATCH", "url": "https://healthcare.googleapis.com/v1/:parent/fhir/:type", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "Required. The name of the FHIR store this resource belongs to." }, { "name": "type", "value": "", "type": "path", "description": "Required. The FHIR resource type to update, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/standards/fhir/R4/resourcelist.html))." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "If a resource is found with the identifier specified in the query parameters, updates part of that resource by applying the operations specified in a [JSON Patch](http://jsonpatch.com/) document. Implements the FHIR standard conditional patch interaction, limited to searching by resource identifier. DSTU2 doesn't define a conditional patch method, but the server supports it in the same way it supports STU3. Search term for identifier should be in the pattern `identifier=system|value` or `identif" }, { "info": { "name": "healthcare.projects.locations.datasets.fhirStores.fhir.conditionalDelete", "type": "http" }, "http": { "method": "DELETE", "url": "https://healthcare.googleapis.com/v1/:parent/fhir/:type", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "Required. The name of the FHIR store this resource belongs to." }, { "name": "type", "value": "", "type": "path", "description": "Required. The FHIR resource type to delete, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/standards/fhir/R4/resourcelist.html))." } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "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_ver" }, { "info": { "name": "healthcare.projects.locations.datasets.fhirStores.fhir.Resource-validate", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1/:parent/fhir/:type/$validate", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "Required. The name of the FHIR store that holds the profiles being used for validation." }, { "name": "type", "value": "", "type": "path", "description": "Required. The FHIR resource type of the resource being validated. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), or [R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html)). Must match the resource type in the provided content." }, { "name": "profile", "value": "", "type": "query", "description": "Required. The canonical URL of a profile that this resource should be validated against. For example, to validate a Patient resource against the US Core Patient profile this parameter would be `http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient`. A StructureDefinition with this canonical URL must exist in the FHIR store." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Validates an input FHIR resource's conformance to its profiles and the profiles configured on the FHIR store. Implements the FHIR extended operation $validate ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resource-operations.html#validate), [STU3](http://hl7.org/implement/standards/fhir/STU3/resource-operations.html#validate), or [R4](http://hl7.org/implement/standards/fhir/R4/resource-operation-validate.html)). The request body must contain a JSON-encoded FHIR resource, and the request" }, { "info": { "name": "healthcare.projects.locations.datasets.fhirStores.list", "type": "http" }, "http": { "method": "GET", "url": "https://healthcare.googleapis.com/v1/:parent/fhirStores", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "Required. Name of the dataset." }, { "name": "filter", "value": "", "type": "query", "description": "Restricts stores returned to those matching a filter. The following syntax is available: * A string field value can be written as text inside quotation marks, for example `\"query text\"`. The only valid relational operation for text fields is equality (`=`), where text is searched within the field, rather than having the field be equal to the text. For example, `\"Comment = great\"` returns messages with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. Only filtering on labels is supported, for example `labels.key=value`." }, { "name": "pageSize", "value": "", "type": "query", "description": "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." }, { "name": "pageToken", "value": "", "type": "query", "description": "The next_page_token value returned from the previous List request, if any." } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Lists the FHIR stores in the given dataset." }, { "info": { "name": "healthcare.projects.locations.datasets.fhirStores.create", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1/:parent/fhirStores", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "Required. The name of the dataset this FHIR store belongs to." }, { "name": "fhirStoreId", "value": "", "type": "query", "description": "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": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Creates a new FHIR store within the parent dataset." }, { "info": { "name": "healthcare.projects.locations.datasets.hl7V2Stores.list", "type": "http" }, "http": { "method": "GET", "url": "https://healthcare.googleapis.com/v1/:parent/hl7V2Stores", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "Required. Name of the dataset." }, { "name": "filter", "value": "", "type": "query", "description": "Restricts stores returned to those matching a filter. The following syntax is available: * A string field value can be written as text inside quotation marks, for example `\"query text\"`. The only valid relational operation for text fields is equality (`=`), where text is searched within the field, rather than having the field be equal to the text. For example, `\"Comment = great\"` returns messages with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. Only filtering on labels is supported. For example, `labels.key=value`." }, { "name": "pageSize", "value": "", "type": "query", "description": "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." }, { "name": "pageToken", "value": "", "type": "query", "description": "The next_page_token value returned from the previous List request, if any." } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Lists the HL7v2 stores in the given dataset." }, { "info": { "name": "healthcare.projects.locations.datasets.hl7V2Stores.create", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1/:parent/hl7V2Stores", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "Required. The name of the dataset this HL7v2 store belongs to." }, { "name": "hl7V2StoreId", "value": "", "type": "query", "description": "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": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Creates a new HL7v2 store within the parent dataset." }, { "info": { "name": "healthcare.projects.locations.datasets.hl7V2Stores.messages.list", "type": "http" }, "http": { "method": "GET", "url": "https://healthcare.googleapis.com/v1/:parent/messages", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "Required. Name of the HL7v2 store to retrieve messages from." }, { "name": "filter", "value": "", "type": "query", "description": "Restricts messages returned to those matching a filter. The following syntax is available: * A string field value can be written as text inside quotation marks, for example `\"query text\"`. The only valid relational operation for text fields is equality (`=`), where text is searched within the field, rather than having the field be equal to the text. For example, `\"Comment = great\"` returns messages with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. Fields/functions available for filtering are: * `message_type`, from the MSH-9.1 field. For example, `NOT message_type = \"ADT\"`. * `send_date` or `sendDate`, the YYYY-MM-DD date the message was sent in the dataset's time_zone, from the MSH-7 segment. For example, `send_date < \"2017-01-02\"`. * `send_time`, the timestamp when the message was sent, using the RFC3339 time format for comparisons, from the MSH-7 segment. For example, `send_time < \"2017-01-02T00:00:00-05:00\"`. * `create_time`, the timestamp when the message was created in the HL7v2 store. Use the RFC3339 time format for comparisons. For example, `create_time < \"2017-01-02T00:00:00-05:00\"`. * `send_facility`, the care center that the message came from, from the MSH-4 segment. For example, `send_facility = \"ABC\"`. * `PatientId(value, type)`, which matches if the message lists a patient having an ID of the given value and type in the PID-2, PID-3, or PID-4 segments. For example, `PatientId(\"123456\", \"MRN\")`. * `labels.x`, a string value of the label with key `x` as set using the Message.labels map. For example, `labels.\"priority\"=\"high\"`. The operator `:*` can be used to assert the existence of a label. For example, `labels.\"priority\":*`." }, { "name": "orderBy", "value": "", "type": "query", "description": "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`" }, { "name": "pageSize", "value": "", "type": "query", "description": "Limit on the number of messages to return in a single response. If not specified, 100 is used. May not be larger than 1000." }, { "name": "pageToken", "value": "", "type": "query", "description": "The next_page_token value returned from the previous List request, if any." }, { "name": "view", "value": "", "type": "query", "description": "Specifies the parts of the Message to return in the response. When unspecified, equivalent to BASIC. Setting this to anything other than BASIC with a `page_size` larger than the default can generate a large response, which impacts the performance of this method." } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "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." }, { "info": { "name": "healthcare.projects.locations.datasets.hl7V2Stores.messages.create", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1/:parent/messages", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "Required. The name of the HL7v2 store this message belongs to." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "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." }, { "info": { "name": "healthcare.projects.locations.datasets.hl7V2Stores.messages.ingest", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1/:parent/messages:ingest", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "Required. The name of the HL7v2 store this message belongs to." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "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 acknowledgmen" }, { "info": { "name": "healthcare.projects.locations.datasets.consentStores.userDataMappings.list", "type": "http" }, "http": { "method": "GET", "url": "https://healthcare.googleapis.com/v1/:parent/userDataMappings", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "Required. Name of the consent store to retrieve User data mappings from." }, { "name": "filter", "value": "", "type": "query", "description": "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 with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. The fields available for filtering are: - data_id - user_id. For example, `filter=user_id=\\\"user123\\\"`. - archived - archive_time" }, { "name": "pageSize", "value": "", "type": "query", "description": "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." }, { "name": "pageToken", "value": "", "type": "query", "description": "Optional. Token to retrieve the next page of results, or empty to get the first page." } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Lists the User data mappings in the specified consent store." }, { "info": { "name": "healthcare.projects.locations.datasets.consentStores.userDataMappings.create", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1/:parent/userDataMappings", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "Required. Name of the consent store." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Creates a new User data mapping in the parent consent store." }, { "info": { "name": "healthcare.projects.locations.datasets.hl7V2Stores.getIamPolicy", "type": "http" }, "http": { "method": "GET", "url": "https://healthcare.googleapis.com/v1/:resource:getIamPolicy", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "resource", "value": "", "type": "path", "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field." }, { "name": "options.requestedPolicyVersion", "value": "", "type": "query", "description": "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](https://cloud.google.com/iam/help/conditions/resource-policies)." } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set." }, { "info": { "name": "healthcare.projects.locations.datasets.hl7V2Stores.setIamPolicy", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1/:resource:setIamPolicy", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "resource", "value": "", "type": "path", "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors." }, { "info": { "name": "healthcare.projects.locations.datasets.hl7V2Stores.testIamPermissions", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1/:resource:testIamPermissions", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "resource", "value": "", "type": "path", "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "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." }, { "info": { "name": "healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.getSeriesMetrics", "type": "http" }, "http": { "method": "GET", "url": "https://healthcare.googleapis.com/v1/:series:getSeriesMetrics", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "series", "value": "", "type": "path", "description": "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}`." } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "GetSeriesMetrics returns metrics for a series." }, { "info": { "name": "healthcare.projects.locations.datasets.deidentify", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1/:sourceDataset:deidentify", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "sourceDataset", "value": "", "type": "path", "description": "Required. Source dataset resource name. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "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. F" }, { "info": { "name": "healthcare.projects.locations.datasets.fhirStores.deidentify", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1/:sourceStore:deidentify", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "sourceStore", "value": "", "type": "path", "description": "Required. Source FHIR store resource name. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "De-identifies data from the source store and writes it to the destination store. The metadata field type is OperationMetadata. If the request is successful, the response field type is DeidentifyFhirStoreSummary. If errors occur, error is set. Error details are also logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging))." }, { "info": { "name": "healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.getStudyMetrics", "type": "http" }, "http": { "method": "GET", "url": "https://healthcare.googleapis.com/v1/:study:getStudyMetrics", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "study", "value": "", "type": "path", "description": "Required. The study resource path. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}/dicomWeb/studies/{study_uid}`." } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "GetStudyMetrics returns metrics for a study." }, { "info": { "name": "healthcare.projects.locations.datasets.consentStores.checkDataAccess", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1beta1/:consentStore:checkDataAccess", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "consentStore", "value": "", "type": "path", "description": "Required. Name of the consent store where the requested data_id is stored, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}`." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Checks if a particular data_id of a User data mapping in the specified consent store is consented for the specified use." }, { "info": { "name": "healthcare.projects.locations.datasets.consentStores.evaluateUserConsents", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1beta1/:consentStore:evaluateUserConsents", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "consentStore", "value": "", "type": "path", "description": "Required. Name of the consent store to retrieve User data mappings from." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "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." }, { "info": { "name": "healthcare.projects.locations.datasets.consentStores.queryAccessibleData", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1beta1/:consentStore:queryAccessibleData", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "consentStore", "value": "", "type": "path", "description": "Required. Name of the consent store to retrieve User data mappings from." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "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 C" }, { "info": { "name": "healthcare.projects.locations.datasets.operations.get", "type": "http" }, "http": { "method": "GET", "url": "https://healthcare.googleapis.com/v1beta1/:name", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "name", "value": "", "type": "path", "description": "The name of the operation resource." }, { "name": "view", "value": "", "type": "query", "description": "Specifies which parts of the Message resource to return in the response. When unspecified, equivalent to FULL." } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "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." }, { "info": { "name": "healthcare.projects.locations.datasets.fhirStores.fhir.update", "type": "http" }, "http": { "method": "PUT", "url": "https://healthcare.googleapis.com/v1beta1/:name", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "name", "value": "", "type": "path", "description": "Required. The name of the resource to update." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Updates the entire contents of a resource. Implements the FHIR standard update interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#update), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#update), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#update)). If the specified resource does not exist and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. It is strongly advised not to include or encode any " }, { "info": { "name": "healthcare.projects.locations.datasets.hl7V2Stores.messages.patch", "type": "http" }, "http": { "method": "PATCH", "url": "https://healthcare.googleapis.com/v1beta1/:name", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "name", "value": "", "type": "path", "description": "Output only. Resource name of the Message, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. Assigned by the server." }, { "name": "updateMask", "value": "", "type": "query", "description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Update the message. The contents of the message in Message.data and data extracted from the contents such as Message.create_time can't 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." }, { "info": { "name": "healthcare.projects.locations.datasets.hl7V2Stores.messages.delete", "type": "http" }, "http": { "method": "DELETE", "url": "https://healthcare.googleapis.com/v1beta1/:name", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "name", "value": "", "type": "path", "description": "Required. The resource name of the HL7v2 message to delete." } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Deletes an HL7v2 message." }, { "info": { "name": "healthcare.projects.locations.datasets.fhirStores.fhir.Patient-consent-enforcement-status", "type": "http" }, "http": { "method": "GET", "url": "https://healthcare.googleapis.com/v1beta1/:name/$consent-enforcement-status", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "name", "value": "", "type": "path", "description": "Required. The name of the patient to find enforcement statuses, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Patient/{patient_id}`" }, { "name": "_count", "value": "", "type": "query", "description": "Optional. The maximum number of results on a page. If not specified, 100 is used. May not be larger than 1000." }, { "name": "_page_token", "value": "", "type": "query", "description": "Optional. Used to retrieve the first, previous, next, or last page of consent enforcement statuses when using pagination. Value should be set to the value of `_page_token` set in next or previous page links' URLs. Next and previous page are returned in the response bundle's links field, where `link.relation` is \"previous\" or \"next\". Omit `_page_token` if no previous request has been made." } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Returns the consent enforcement status of all consent resources for a patient. On success, the response body contains a JSON-encoded representation of a bundle of `Parameters` (http://hl7.org/fhir/parameters.html) FHIR resources, containing the current enforcement status for each consent resource of the patient. Does not support DSTU2." }, { "info": { "name": "healthcare.projects.locations.datasets.fhirStores.fhir.Patient-everything", "type": "http" }, "http": { "method": "GET", "url": "https://healthcare.googleapis.com/v1beta1/:name/$everything", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "name", "value": "", "type": "path", "description": "Required. Name of the `Patient` resource for which the information is required." }, { "name": "_count", "value": "", "type": "query", "description": "Maximum number of resources in a page. If not specified, 100 is used. May not be larger than 1000." }, { "name": "_page_token", "value": "", "type": "query", "description": "Used to retrieve the next or previous page of results when using pagination. Set `_page_token` to the value of _page_token set in next or previous page links' url. Next and previous page are returned in the response bundle's links field, where `link.relation` is \"previous\" or \"next\". Omit `_page_token` if no previous request has been made." }, { "name": "_since", "value": "", "type": "query", "description": "If provided, only resources updated after this time are returned. The time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. For example, `2015-02-07T13:28:17.239+02:00` or `2017-01-01T00:00:00Z`. The time must be specified to the second and include a time zone." }, { "name": "_type", "value": "", "type": "query", "description": "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." }, { "name": "end", "value": "", "type": "query", "description": "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." }, { "name": "start", "value": "", "type": "query", "description": "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." } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Retrieves a Patient resource and resources related to that patient. Implements the FHIR extended operation Patient-everything ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/patient-operations.html#everything), [STU3](https://hl7.org/implement/standards/fhir/STU3/patient-operations.html#everything), [R4](https://hl7.org/implement/standards/fhir/R4/patient-operations.html#everything)). On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `sea" }, { "info": { "name": "healthcare.projects.locations.datasets.fhirStores.fhir.Resource-purge", "type": "http" }, "http": { "method": "DELETE", "url": "https://healthcare.googleapis.com/v1beta1/:name/$purge", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "name", "value": "", "type": "path", "description": "Required. The name of the resource to purge." } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Deletes all the historical versions of a resource (excluding the current version) from the FHIR store. To remove all versions of a resource, first delete the current version and then call this method. This is not a FHIR standard operation. For samples that show how to call `Resource-purge`, see [Deleting historical versions of a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#deleting_historical_versions_of_a_fhir_resource)." }, { "info": { "name": "healthcare.projects.locations.datasets.fhirStores.fhir.ConceptMap-translate", "type": "http" }, "http": { "method": "GET", "url": "https://healthcare.googleapis.com/v1beta1/:name/$translate", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "name", "value": "", "type": "path", "description": "Required. The URL for the concept map to use for the translation." }, { "name": "code", "value": "", "type": "query", "description": "Required. The code to translate." }, { "name": "conceptMapVersion", "value": "", "type": "query", "description": "The version of the concept map to use. If unset, the most current version is used." }, { "name": "system", "value": "", "type": "query", "description": "Required. The system for the code to be translated." } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Translates a code from one value set to another using a concept map. You can provide your own concept maps to translate any code system to another code system. Implements the FHIR standard $translate operation ([DSTU2](https://www.hl7.org/fhir/DSTU2/operation-conceptmap-translate.html), [STU3](https://www.hl7.org/fhir/STU3/operation-conceptmap-translate.html), [R4](https://www.hl7.org/fhir/R4/operation-conceptmap-translate.html)). On success, the response body contains a JSON-encoded representat" }, { "info": { "name": "healthcare.projects.locations.datasets.fhirStores.fhir.history", "type": "http" }, "http": { "method": "GET", "url": "https://healthcare.googleapis.com/v1beta1/:name/_history", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "name", "value": "", "type": "path", "description": "Required. The name of the resource to retrieve." }, { "name": "_at", "value": "", "type": "query", "description": "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`" }, { "name": "_count", "value": "", "type": "query", "description": "The maximum number of search results on a page. If not specified, 100 is used. May not be larger than 1000." }, { "name": "_page_token", "value": "", "type": "query", "description": "Used to retrieve the first, previous, next, or last page of resource versions when using pagination. Value should be set to the value of `_page_token` set in next or previous page links' URLs. Next and previous page are returned in the response bundle's links field, where `link.relation` is \"previous\" or \"next\". Omit `_page_token` if no previous request has been made." }, { "name": "_since", "value": "", "type": "query", "description": "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." } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "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](https://hl7.org/implement/standards/fhir/DSTU2/http.html#history), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#history), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#history)). On success, the response body contains a JSON-encoded representation of a `Bundle` resource of t" }, { "info": { "name": "healthcare.projects.locations.datasets.fhirStores.fhir.capabilities", "type": "http" }, "http": { "method": "GET", "url": "https://healthcare.googleapis.com/v1beta1/:name/fhir/metadata", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "name", "value": "", "type": "path", "description": "Required. Name of the FHIR store to retrieve the capabilities for." } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Gets the FHIR capability statement ([STU3](https://hl7.org/implement/standards/fhir/STU3/capabilitystatement.html), [R4](https://hl7.org/implement/standards/fhir/R4/capabilitystatement.html)), or the [conformance statement](https://hl7.org/implement/standards/fhir/DSTU2/conformance.html) in the DSTU2 case for the store, which contains a description of functionality supported by the server. Implements the FHIR standard capabilities interaction ([STU3](https://hl7.org/implement/standards/fhir/STU3" }, { "info": { "name": "healthcare.projects.locations.list", "type": "http" }, "http": { "method": "GET", "url": "https://healthcare.googleapis.com/v1beta1/:name/locations", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "name", "value": "", "type": "path", "description": "The resource that owns the locations collection, if applicable." }, { "name": "filter", "value": "", "type": "query", "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160)." }, { "name": "pageSize", "value": "", "type": "query", "description": "The maximum number of results to return. If not set, the service selects a default." }, { "name": "pageToken", "value": "", "type": "query", "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page." } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Lists information about the supported locations for this service." }, { "info": { "name": "healthcare.projects.locations.datasets.operations.list", "type": "http" }, "http": { "method": "GET", "url": "https://healthcare.googleapis.com/v1beta1/:name/operations", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "name", "value": "", "type": "path", "description": "The name of the operation's parent resource." }, { "name": "filter", "value": "", "type": "query", "description": "The standard list filter." }, { "name": "pageSize", "value": "", "type": "query", "description": "The standard list page size." }, { "name": "pageToken", "value": "", "type": "query", "description": "The standard list page token." } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`." }, { "info": { "name": "healthcare.projects.locations.datasets.consentStores.consents.activate", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1beta1/:name:activate", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "name", "value": "", "type": "path", "description": "Required. The resource name of the Consent to activate, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}`. An INVALID_ARGUMENT error occurs if `revision_id` is specified in the name." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "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." }, { "info": { "name": "healthcare.projects.locations.datasets.fhirStores.applyAdminConsents", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1beta1/:name:applyAdminConsents", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "name", "value": "", "type": "path", "description": "Required. The name of the FHIR store to enforce, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Applies the admin Consent resources for the FHIR store and reindexes the underlying resources in the FHIR store according to the aggregate consents. This method also updates the `consent_config.enforced_admin_consents` field of the FhirStore unless `validate_only=true` in ApplyAdminConsentsRequest. Any admin Consent resource change after this operation execution (including deletion) requires you to call ApplyAdminConsents again for the change to take effect. This method returns an Operation that" }, { "info": { "name": "healthcare.projects.locations.datasets.fhirStores.applyConsents", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1beta1/:name:applyConsents", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "name", "value": "", "type": "path", "description": "Required. The name of the FHIR store to enforce, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Apply the Consent resources for the FHIR store and reindex the underlying resources in the FHIR store according to the aggregate consent. The aggregate consent of the patient in scope in this request replaces any previous call of this method. Any Consent resource change after this operation execution (including deletion) requires you to call ApplyConsents again to have effect. This method returns an Operation that can be used to track the progress of the consent resources that were processed by " }, { "info": { "name": "healthcare.projects.locations.datasets.consentStores.userDataMappings.archive", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1beta1/:name:archive", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "name", "value": "", "type": "path", "description": "Required. The resource name of the User data mapping to archive." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Archives the specified User data mapping." }, { "info": { "name": "healthcare.projects.locations.datasets.operations.cancel", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1beta1/:name:cancel", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "name", "value": "", "type": "path", "description": "The name of the operation resource to be cancelled." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "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 Operati" }, { "info": { "name": "healthcare.projects.locations.datasets.fhirStores.configureSearch", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1beta1/:name:configureSearch", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "name", "value": "", "type": "path", "description": "Required. The name of the FHIR store to configure, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Configure the search parameters for the FHIR store and reindex resources in the FHIR store according to the defined search parameters. The search parameters provided in this request will replace any previous search configuration. The target SearchParameter resources need to exist in the store before calling ConfigureSearch, otherwise an error will occur. This method returns an Operation that can be used to track the progress of the reindexing by calling GetOperation." }, { "info": { "name": "healthcare.projects.locations.datasets.consentStores.consents.deleteRevision", "type": "http" }, "http": { "method": "DELETE", "url": "https://healthcare.googleapis.com/v1beta1/:name:deleteRevision", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "name", "value": "", "type": "path", "description": "Required. The resource name of the Consent revision to delete, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}@{revision_id}`. An INVALID_ARGUMENT error occurs if `revision_id` is not specified in the name." } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Deletes the specified revision of a Consent. An INVALID_ARGUMENT error occurs if the specified revision is the latest revision." }, { "info": { "name": "healthcare.projects.locations.datasets.annotationStores.evaluate", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1beta1/:name:evaluate", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "name", "value": "", "type": "path", "description": "Required. The Annotation store to compare against `golden_store`, in the format of `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}`." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Evaluate an Annotation store against a ground truth Annotation store. When the operation finishes successfully, a detailed response is returned of type EvaluateAnnotationStoreResponse, contained in the response. The metadata field type is OperationMetadata. Errors are logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging))." }, { "info": { "name": "healthcare.projects.locations.datasets.fhirStores.explainDataAccess", "type": "http" }, "http": { "method": "GET", "url": "https://healthcare.googleapis.com/v1beta1/:name:explainDataAccess", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "name", "value": "", "type": "path", "description": "Required. The name of the FHIR store to enforce, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`." }, { "name": "resourceId", "value": "", "type": "query", "description": "Required. The ID (`{resourceType}/{id}`) of the resource to explain data access on." } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Explains all the permitted/denied actor, purpose and environment for a given resource." }, { "info": { "name": "healthcare.projects.locations.datasets.hl7V2Stores.export", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1beta1/:name:export", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "name", "value": "", "type": "path", "description": "Required. The name of the source HL7v2 store, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7v2Stores/{hl7v2_store_id}`" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "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 Operat" }, { "info": { "name": "healthcare.projects.locations.datasets.dicomStores.getDICOMStoreMetrics", "type": "http" }, "http": { "method": "GET", "url": "https://healthcare.googleapis.com/v1beta1/:name:getDICOMStoreMetrics", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "name", "value": "", "type": "path", "description": "Required. The resource name of the DICOM store to get metrics for." } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Gets metrics associated with the DICOM store." }, { "info": { "name": "healthcare.projects.locations.datasets.fhirStores.getFHIRStoreMetrics", "type": "http" }, "http": { "method": "GET", "url": "https://healthcare.googleapis.com/v1beta1/:name:getFHIRStoreMetrics", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "name", "value": "", "type": "path", "description": "Required. The resource name of the FHIR store to get metrics for." } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Gets metrics associated with the FHIR store." }, { "info": { "name": "healthcare.projects.locations.datasets.hl7V2Stores.getHL7v2StoreMetrics", "type": "http" }, "http": { "method": "GET", "url": "https://healthcare.googleapis.com/v1beta1/:name:getHL7v2StoreMetrics", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "name", "value": "", "type": "path", "description": "Required. The resource name of the HL7v2 store to get metrics for, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`." } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Gets metrics associated with the HL7v2 store." }, { "info": { "name": "healthcare.projects.locations.datasets.hl7V2Stores.import", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1beta1/:name:import", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "name", "value": "", "type": "path", "description": "Required. The name of the target HL7v2 store, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7v2Stores/{hl7v2_store_id}`" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "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 messag" }, { "info": { "name": "healthcare.projects.locations.datasets.consentStores.consents.listRevisions", "type": "http" }, "http": { "method": "GET", "url": "https://healthcare.googleapis.com/v1beta1/:name:listRevisions", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "name", "value": "", "type": "path", "description": "Required. The resource name of the Consent to retrieve revisions for." }, { "name": "filter", "value": "", "type": "query", "description": "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 with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. Fields/functions available for filtering are: - user_id. For example, `filter='user_id=\"user123\"'`. - consent_artifact - state - revision_create_time - metadata. For example, `filter=Metadata(\\\"testkey\\\")=\\\"value\\\"` or `filter=HasMetadata(\\\"testkey\\\")`." }, { "name": "pageSize", "value": "", "type": "query", "description": "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." }, { "name": "pageToken", "value": "", "type": "query", "description": "Optional. Token to retrieve the next page of results or empty if there are no more results in the list." } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Lists the revisions of the specified Consent in reverse chronological order." }, { "info": { "name": "healthcare.projects.locations.datasets.consentStores.consents.reject", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1beta1/:name:reject", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "name", "value": "", "type": "path", "description": "Required. The resource name of the Consent to reject, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}`. An INVALID_ARGUMENT error occurs if `revision_id` is specified in the name." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "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." }, { "info": { "name": "healthcare.projects.locations.datasets.consentStores.consents.revoke", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1beta1/:name:revoke", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "name", "value": "", "type": "path", "description": "Required. The resource name of the Consent to revoke, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}`. An INVALID_ARGUMENT error occurs if `revision_id` is specified in the name." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "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." }, { "info": { "name": "healthcare.projects.locations.datasets.fhirStores.rollback", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1beta1/:name:rollback", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "name", "value": "", "type": "path", "description": "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}\"." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Rolls back resources from the FHIR store to the specified time. This method returns an Operation that can be used to track the status of the rollback by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). Otherwise, when the operation finishes, a detailed response of type RollbackFhirResourcesResponse is returned in the response field." }, { "info": { "name": "healthcare.projects.locations.services.nlp.analyzeEntities", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1beta1/:nlpService:analyzeEntities", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "nlpService", "value": "", "type": "path", "description": "The resource name of the service of the form: \"projects/{project_id}/locations/{location_id}/services/nlp\"." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "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. This method can only analyze documents written in English." }, { "info": { "name": "healthcare.projects.locations.datasets.annotationStores.list", "type": "http" }, "http": { "method": "GET", "url": "https://healthcare.googleapis.com/v1beta1/:parent/annotationStores", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "Required. Name of the dataset." }, { "name": "filter", "value": "", "type": "query", "description": "Restricts stores returned to those matching a filter. The following syntax is available: * A string field value can be written as text inside quotation marks, for example `\"query text\"`. The only valid relational operation for text fields is equality (`=`), where text is searched within the field, rather than having the field be equal to the text. For example, `\"Comment = great\"` returns messages with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. Only filtering on labels is supported, for example `labels.key=value`." }, { "name": "pageSize", "value": "", "type": "query", "description": "Limit on the number of Annotation stores to return in a single response. If not specified, 100 is used. May not be larger than 1000." }, { "name": "pageToken", "value": "", "type": "query", "description": "The next_page_token value returned from the previous List request, if any." } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Lists the Annotation stores in the given dataset for a source store." }, { "info": { "name": "healthcare.projects.locations.datasets.annotationStores.create", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1beta1/:parent/annotationStores", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "Required. The name of the dataset this Annotation store belongs to." }, { "name": "annotationStoreId", "value": "", "type": "query", "description": "Required. The ID of the Annotation store that is being created. The string must match the following regex: `[\\p{L}\\p{N}_\\-\\.]{1,256}`." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Creates a new Annotation store within the parent dataset." }, { "info": { "name": "healthcare.projects.locations.datasets.annotationStores.annotations.list", "type": "http" }, "http": { "method": "GET", "url": "https://healthcare.googleapis.com/v1beta1/:parent/annotations", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "Required. Name of the Annotation store to retrieve Annotations from." }, { "name": "filter", "value": "", "type": "query", "description": "Restricts Annotations returned to those matching a filter. Functions available for filtering are: - `matches(\"annotation_source.cloud_healthcare_source.name\", substring)`. Filter on `cloud_healthcare_source.name`. For example: `matches(\"annotation_source.cloud_healthcare_source.name\", \"some source\")`. - `matches(\"annotation\", substring)`. Filter on all fields of annotation. For example: `matches(\"annotation\", \"some-content\")`. - `type(\"text\")`, `type(\"image\")`, `type(\"resource\")`. Filter on the type of annotation `data`." }, { "name": "pageSize", "value": "", "type": "query", "description": "Limit on the number of Annotations to return in a single response. If not specified, 100 is used. May not be larger than 1000." }, { "name": "pageToken", "value": "", "type": "query", "description": "The next_page_token value returned from the previous List request, if any." }, { "name": "view", "value": "", "type": "query", "description": "Controls which fields are populated in the response." } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Lists the Annotations in the given Annotation store for a source resource." }, { "info": { "name": "healthcare.projects.locations.datasets.annotationStores.annotations.create", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1beta1/:parent/annotations", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "Required. The name of the Annotation store this annotation belongs to. For example, `projects/my-project/locations/us-central1/datasets/mydataset/annotationStores/myannotationstore`." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Creates a new Annotation record. It is valid to create Annotation objects for the same source more than once since a unique ID is assigned to each record by this service." }, { "info": { "name": "healthcare.projects.locations.datasets.consentStores.attributeDefinitions.list", "type": "http" }, "http": { "method": "GET", "url": "https://healthcare.googleapis.com/v1beta1/:parent/attributeDefinitions", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "Required. Name of the consent store to retrieve Attribute definitions from." }, { "name": "filter", "value": "", "type": "query", "description": "Optional. Restricts the attributes returned to those matching a filter. The following syntax is available: * A string field value can be written as text inside quotation marks, for example `\"query text\"`. The only valid relational operation for text fields is equality (`=`), where text is searched within the field, rather than having the field be equal to the text. For example, `\"Comment = great\"` returns messages with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. The only field available for filtering is `category`. For example, `filter=category=\\\"REQUEST\\\"`." }, { "name": "pageSize", "value": "", "type": "query", "description": "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." }, { "name": "pageToken", "value": "", "type": "query", "description": "Optional. Token to retrieve the next page of results or empty to get the first page." } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Lists the Attribute definitions in the specified consent store." }, { "info": { "name": "healthcare.projects.locations.datasets.consentStores.attributeDefinitions.create", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1beta1/:parent/attributeDefinitions", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "Required. The name of the consent store that this Attribute definition belongs to." }, { "name": "attributeDefinitionId", "value": "", "type": "query", "description": "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": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Creates a new Attribute definition in the parent consent store." }, { "info": { "name": "healthcare.projects.locations.datasets.consentStores.consentArtifacts.list", "type": "http" }, "http": { "method": "GET", "url": "https://healthcare.googleapis.com/v1beta1/:parent/consentArtifacts", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "Required. Name of the consent store to retrieve consent artifacts from." }, { "name": "filter", "value": "", "type": "query", "description": "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 with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. The fields available for filtering are: - user_id. For example, `filter=user_id=\\\"user123\\\"`. - consent_content_version - metadata. For example, `filter=Metadata(\\\"testkey\\\")=\\\"value\\\"` or `filter=HasMetadata(\\\"testkey\\\")`." }, { "name": "pageSize", "value": "", "type": "query", "description": "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." }, { "name": "pageToken", "value": "", "type": "query", "description": "Optional. The next_page_token value returned from the previous List request, if any." } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Lists the Consent artifacts in the specified consent store." }, { "info": { "name": "healthcare.projects.locations.datasets.consentStores.consentArtifacts.create", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1beta1/:parent/consentArtifacts", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "Required. The name of the consent store this Consent artifact belongs to." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Creates a new Consent artifact in the parent consent store." }, { "info": { "name": "healthcare.projects.locations.datasets.consentStores.list", "type": "http" }, "http": { "method": "GET", "url": "https://healthcare.googleapis.com/v1beta1/:parent/consentStores", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "Required. Name of the dataset." }, { "name": "filter", "value": "", "type": "query", "description": "Optional. Restricts the stores returned to those matching a filter. The following syntax is available: * A string field value can be written as text inside quotation marks, for example `\"query text\"`. The only valid relational operation for text fields is equality (`=`), where text is searched within the field, rather than having the field be equal to the text. For example, `\"Comment = great\"` returns messages with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. Only filtering on labels is supported. For example, `filter=labels.key=value`." }, { "name": "pageSize", "value": "", "type": "query", "description": "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." }, { "name": "pageToken", "value": "", "type": "query", "description": "Optional. Token to retrieve the next page of results, or empty to get the first page." } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Lists the consent stores in the specified dataset." }, { "info": { "name": "healthcare.projects.locations.datasets.consentStores.create", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1beta1/:parent/consentStores", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "Required. The name of the dataset this consent store belongs to." }, { "name": "consentStoreId", "value": "", "type": "query", "description": "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": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "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." }, { "info": { "name": "healthcare.projects.locations.datasets.consentStores.consents.list", "type": "http" }, "http": { "method": "GET", "url": "https://healthcare.googleapis.com/v1beta1/:parent/consents", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "Required. Name of the consent store to retrieve Consents from." }, { "name": "filter", "value": "", "type": "query", "description": "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 with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. The fields available for filtering are: - user_id. For example, `filter='user_id=\"user123\"'`. - consent_artifact - state - revision_create_time - metadata. For example, `filter=Metadata(\\\"testkey\\\")=\\\"value\\\"` or `filter=HasMetadata(\\\"testkey\\\")`." }, { "name": "pageSize", "value": "", "type": "query", "description": "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." }, { "name": "pageToken", "value": "", "type": "query", "description": "Optional. The next_page_token value returned from the previous List request, if any." } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Lists the Consent in the given consent store, returning each Consent's latest revision." }, { "info": { "name": "healthcare.projects.locations.datasets.consentStores.consents.create", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1beta1/:parent/consents", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "Required. Name of the consent store." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Creates a new Consent in the parent consent store." }, { "info": { "name": "healthcare.projects.locations.datasets.list", "type": "http" }, "http": { "method": "GET", "url": "https://healthcare.googleapis.com/v1beta1/:parent/datasets", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "Required. The name of the project whose datasets should be listed. For example, `projects/{project_id}/locations/{location_id}`." }, { "name": "pageSize", "value": "", "type": "query", "description": "The maximum number of items to return. If not specified, 100 is used. May not be larger than 1000." }, { "name": "pageToken", "value": "", "type": "query", "description": "The next_page_token value returned from a previous List request, if any." } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Lists the health datasets in the current project." }, { "info": { "name": "healthcare.projects.locations.datasets.create", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1beta1/:parent/datasets", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "Required. The name of the project where the server creates the dataset. For example, `projects/{project_id}/locations/{location_id}`." }, { "name": "datasetId", "value": "", "type": "query", "description": "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": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "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." }, { "info": { "name": "healthcare.projects.locations.datasets.dicomStores.list", "type": "http" }, "http": { "method": "GET", "url": "https://healthcare.googleapis.com/v1beta1/:parent/dicomStores", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "Required. Name of the dataset." }, { "name": "filter", "value": "", "type": "query", "description": "Restricts stores returned to those matching a filter. The following syntax is available: * A string field value can be written as text inside quotation marks, for example `\"query text\"`. The only valid relational operation for text fields is equality (`=`), where text is searched within the field, rather than having the field be equal to the text. For example, `\"Comment = great\"` returns messages with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. Only filtering on labels is supported. For example, `labels.key=value`." }, { "name": "pageSize", "value": "", "type": "query", "description": "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." }, { "name": "pageToken", "value": "", "type": "query", "description": "The next_page_token value returned from the previous List request, if any." } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Lists the DICOM stores in the given dataset." }, { "info": { "name": "healthcare.projects.locations.datasets.dicomStores.create", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1beta1/:parent/dicomStores", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "Required. The name of the dataset this DICOM store belongs to." }, { "name": "dicomStoreId", "value": "", "type": "query", "description": "Required. The ID of the DICOM store that is being created. Any string value up to 256 characters in length." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Creates a new DICOM store within the parent dataset." }, { "info": { "name": "healthcare.projects.locations.datasets.dicomStores.studies.series.instances.frames.retrieveRendered", "type": "http" }, "http": { "method": "GET", "url": "https://healthcare.googleapis.com/v1beta1/:parent/dicomWeb/:dicomWebPath", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "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}`." }, { "name": "dicomWebPath", "value": "", "type": "path", "description": "Required. The path of the RetrieveRenderedFrames DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}/frames/{frame_list}/rendered`." } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "RetrieveRenderedFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers in an acceptable Rendered Media Type. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedFrames, see [Rendered resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call R" }, { "info": { "name": "healthcare.projects.locations.datasets.dicomStores.studies.storeInstances", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1beta1/:parent/dicomWeb/:dicomWebPath", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "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}`." }, { "name": "dicomWebPath", "value": "", "type": "path", "description": "Required. The path of the StoreInstances DICOMweb request. For example, `studies/[{study_uid}]`. Note that the `study_uid` is optional." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). For details on the implementation of StoreInstances, see [Store transaction](https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see [Store DICOM data](https://cloud.google.com/healthca" }, { "info": { "name": "healthcare.projects.locations.datasets.dicomStores.studies.series.instances.delete", "type": "http" }, "http": { "method": "DELETE", "url": "https://healthcare.googleapis.com/v1beta1/:parent/dicomWeb/:dicomWebPath", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "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}`." }, { "name": "dicomWebPath", "value": "", "type": "path", "description": "Required. The path of the DeleteInstance request. For example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}`." } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "DeleteInstance deletes an instance associated with the given study, series, and SOP Instance UID. Delete requests are equivalent to the GET requests specified in the Retrieve transaction. Study and series search results can take a few seconds to be updated after an instance is deleted using DeleteInstance. For samples that show how to call DeleteInstance, see [Delete a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#delete-dicom)." }, { "info": { "name": "healthcare.projects.locations.datasets.fhirStores.fhir.executeBundle", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1beta1/:parent/fhir", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "Required. Name of the FHIR store in which this bundle will be executed." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Executes all the requests in the given Bundle. Implements the FHIR standard batch/transaction interaction and history operations. ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#transaction), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#transaction), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#transaction)). Supports all interactions within a bundle, except search. This method accepts Bundles of type `batch`, `transaction` and `history`, process" }, { "info": { "name": "healthcare.projects.locations.datasets.fhirStores.fhir.Resource-incoming-references", "type": "http" }, "http": { "method": "GET", "url": "https://healthcare.googleapis.com/v1beta1/:parent/fhir/$references", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "Required. The name of the FHIR store that holds the target resource." }, { "name": "_count", "value": "", "type": "query", "description": "Maximum number of resources in a page. If not specified, 100 is used. May not be larger than 1000." }, { "name": "_page_token", "value": "", "type": "query", "description": "Used to retrieve the next page of results when using pagination. Set `_page_token` to the value of _page_token set in next page links' url. Next page are returned in the response bundle's links field, where `link.relation` is \"next\". Omit `_page_token` if no previous request has been made." }, { "name": "_summary", "value": "", "type": "query", "description": "Used to simplify the representation of the returned resources. `_summary=text` returns only the `text`, `id`, and `meta` top-level fields. `_summary=data` removes the `text` field and returns all other fields. `_summary=false` returns all parts of the resource(s). Either not providing this parameter or providing an empty value to this parameter also returns all parts of the resource(s)." }, { "name": "_type", "value": "", "type": "query", "description": "String of comma-delimited FHIR resource types. If provided, only resources of the specified resource type(s) are returned. If not provided or an empty value is provided, no filter on the returned resource type(s) is applied." }, { "name": "target", "value": "", "type": "query", "description": "Required. The target whose incoming references are requested. This param is required and must not be empty. It uses the format \"ResourceType/ResourceID\", for example, target=ResourceType/ResourceID." } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Lists all the resources that directly refer to the given target FHIR resource. Can also support the case when the target resource doesn't exist, for example, if the target has been deleted. On success, the response body contains a Bundle with type `searchset`, where each entry in the Bundle contains the full content of the resource. If the operation fails, an `OperationOutcome` is returned describing the failure. If the request cannot be mapped to a valid API method on a FHIR store, a generic Go" }, { "info": { "name": "healthcare.projects.locations.datasets.fhirStores.fhir.ConceptMap-search-translate", "type": "http" }, "http": { "method": "GET", "url": "https://healthcare.googleapis.com/v1beta1/:parent/fhir/ConceptMap/$translate", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "Required. The name for the FHIR store containing the concept map(s) to use for the translation." }, { "name": "code", "value": "", "type": "query", "description": "Required. The code to translate." }, { "name": "conceptMapVersion", "value": "", "type": "query", "description": "The version of the concept map to use. If unset, the most current version is used." }, { "name": "source", "value": "", "type": "query", "description": "The source value set of the concept map to be used. If unset, target is used to search for concept maps." }, { "name": "system", "value": "", "type": "query", "description": "Required. The system for the code to be translated." }, { "name": "target", "value": "", "type": "query", "description": "The target value set of the concept map to be used. If unset, source is used to search for concept maps." }, { "name": "url", "value": "", "type": "query", "description": "The canonical url of the concept map to use. If unset, the source and target is used to search for concept maps." } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Translates a code from one value set to another by searching for appropriate concept maps. Implements the FHIR standard $translate operation ([DSTU2](https://www.hl7.org/fhir/DSTU2/operation-conceptmap-translate.html), [STU3](https://www.hl7.org/fhir/STU3/operation-conceptmap-translate.html), [R4](https://www.hl7.org/fhir/R4/operation-conceptmap-translate.html)). On success, the response body contains a JSON-encoded representation of a FHIR Parameters resource, which includes the translation res" }, { "info": { "name": "healthcare.projects.locations.datasets.fhirStores.fhir.Observation-lastn", "type": "http" }, "http": { "method": "GET", "url": "https://healthcare.googleapis.com/v1beta1/:parent/fhir/Observation/$lastn", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "Required. Name of the FHIR store to retrieve resources from." } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Retrieves the N most recent `Observation` resources for a subject matching search criteria specified as query parameters, grouped by `Observation.code`, sorted from most recent to oldest. Implements the FHIR extended operation Observation-lastn ([STU3](https://hl7.org/implement/standards/fhir/STU3/observation-operations.html#lastn), [R4](https://hl7.org/implement/standards/fhir/R4/observation-operations.html#lastn)). DSTU2 doesn't define the Observation-lastn method, but the server supports it t" }, { "info": { "name": "healthcare.projects.locations.datasets.fhirStores.fhir.search", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1beta1/:parent/fhir/_search", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "Required. Name of the FHIR store to retrieve resources from." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#search), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/search.html" }, { "info": { "name": "healthcare.projects.locations.datasets.fhirStores.fhir.search-type", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1beta1/:parent/fhir/:resourceType/_search", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "Required. Name of the FHIR store to retrieve resources from." }, { "name": "resourceType", "value": "", "type": "path", "description": "Required. The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/standards/fhir/R4/resourcelist.html))." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#search), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/search.html" }, { "info": { "name": "healthcare.projects.locations.datasets.fhirStores.fhir.create", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1beta1/:parent/fhir/:type", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "Required. The name of the FHIR store this resource belongs to." }, { "name": "type", "value": "", "type": "path", "description": "Required. The FHIR resource type to create, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/standards/fhir/R4/resourcelist.html)). Must match the resource type in the provided content." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Creates a FHIR resource. Implements the FHIR standard create interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#create), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#create), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#create)), which creates a new resource with a server-assigned resource ID. Also supports the FHIR standard conditional create interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#ccreate), [STU3](" }, { "info": { "name": "healthcare.projects.locations.datasets.fhirStores.fhir.conditionalUpdate", "type": "http" }, "http": { "method": "PUT", "url": "https://healthcare.googleapis.com/v1beta1/:parent/fhir/:type", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "Required. The name of the FHIR store this resource belongs to." }, { "name": "type", "value": "", "type": "path", "description": "Required. The FHIR resource type to update, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/standards/fhir/R4/resourcelist.html)). Must match the resource type in the provided content." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "If a resource is found based on the search criteria specified in the query parameters, updates the entire contents of that resource. Implements the FHIR standard conditional update interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.10.2), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#cond-update), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#cond-update)). Search terms are provided as query parameters following the same pattern as t" }, { "info": { "name": "healthcare.projects.locations.datasets.fhirStores.fhir.conditionalPatch", "type": "http" }, "http": { "method": "PATCH", "url": "https://healthcare.googleapis.com/v1beta1/:parent/fhir/:type", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "Required. The name of the FHIR store this resource belongs to." }, { "name": "type", "value": "", "type": "path", "description": "Required. The FHIR resource type to update, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/standards/fhir/R4/resourcelist.html))." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "If a resource is found based on the search criteria specified in the query parameters, updates part of that resource by applying the operations specified in a [JSON Patch](http://jsonpatch.com/) document. Implements the FHIR standard conditional patch interaction ([STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#patch), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#patch)). DSTU2 doesn't define a conditional patch method, but the server supports it in the same way it s" }, { "info": { "name": "healthcare.projects.locations.datasets.fhirStores.fhir.conditionalDelete", "type": "http" }, "http": { "method": "DELETE", "url": "https://healthcare.googleapis.com/v1beta1/:parent/fhir/:type", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "Required. The name of the FHIR store this resource belongs to." }, { "name": "type", "value": "", "type": "path", "description": "Required. The FHIR resource type to delete, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/standards/fhir/R4/resourcelist.html))." } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Deletes FHIR resources that match a search query. Implements the FHIR standard conditional delete interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.12.1), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.13.1), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#3.1.0.7.1)). If multiple resources match, all matching resources are deleted. Search terms are provided as query parameters following the same pattern as the search method. No" }, { "info": { "name": "healthcare.projects.locations.datasets.fhirStores.fhir.Resource-validate", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1beta1/:parent/fhir/:type/$validate", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "Required. The name of the FHIR store that holds the profiles being used for validation." }, { "name": "type", "value": "", "type": "path", "description": "Required. The FHIR resource type of the resource being validated. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), or [R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html)). Must match the resource type in the provided content." }, { "name": "profile", "value": "", "type": "query", "description": "Required. The canonical URL of a profile that this resource should be validated against. For example, to validate a Patient resource against the US Core Patient profile this parameter would be `http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient`. A StructureDefinition with this canonical URL must exist in the FHIR store." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Validates an input FHIR resource's conformance to its profiles and the profiles configured on the FHIR store. Implements the FHIR extended operation $validate ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resource-operations.html#validate), [STU3](http://hl7.org/implement/standards/fhir/STU3/resource-operations.html#validate), or [R4](http://hl7.org/implement/standards/fhir/R4/resource-operation-validate.html)). The request body must contain a JSON-encoded FHIR resource, and the request" }, { "info": { "name": "healthcare.projects.locations.datasets.fhirStores.list", "type": "http" }, "http": { "method": "GET", "url": "https://healthcare.googleapis.com/v1beta1/:parent/fhirStores", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "Required. Name of the dataset." }, { "name": "filter", "value": "", "type": "query", "description": "Restricts stores returned to those matching a filter. The following syntax is available: * A string field value can be written as text inside quotation marks, for example `\"query text\"`. The only valid relational operation for text fields is equality (`=`), where text is searched within the field, rather than having the field be equal to the text. For example, `\"Comment = great\"` returns messages with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. Only filtering on labels is supported, for example `labels.key=value`." }, { "name": "pageSize", "value": "", "type": "query", "description": "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." }, { "name": "pageToken", "value": "", "type": "query", "description": "The next_page_token value returned from the previous List request, if any." } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Lists the FHIR stores in the given dataset." }, { "info": { "name": "healthcare.projects.locations.datasets.fhirStores.create", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1beta1/:parent/fhirStores", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "Required. The name of the dataset this FHIR store belongs to." }, { "name": "fhirStoreId", "value": "", "type": "query", "description": "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": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Creates a new FHIR store within the parent dataset." }, { "info": { "name": "healthcare.projects.locations.datasets.hl7V2Stores.list", "type": "http" }, "http": { "method": "GET", "url": "https://healthcare.googleapis.com/v1beta1/:parent/hl7V2Stores", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "Required. Name of the dataset." }, { "name": "filter", "value": "", "type": "query", "description": "Restricts stores returned to those matching a filter. The following syntax is available: * A string field value can be written as text inside quotation marks, for example `\"query text\"`. The only valid relational operation for text fields is equality (`=`), where text is searched within the field, rather than having the field be equal to the text. For example, `\"Comment = great\"` returns messages with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. Only filtering on labels is supported. For example, `labels.key=value`." }, { "name": "pageSize", "value": "", "type": "query", "description": "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." }, { "name": "pageToken", "value": "", "type": "query", "description": "The next_page_token value returned from the previous List request, if any." } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Lists the HL7v2 stores in the given dataset." }, { "info": { "name": "healthcare.projects.locations.datasets.hl7V2Stores.create", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1beta1/:parent/hl7V2Stores", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "Required. The name of the dataset this HL7v2 store belongs to." }, { "name": "hl7V2StoreId", "value": "", "type": "query", "description": "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": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Creates a new HL7v2 store within the parent dataset." }, { "info": { "name": "healthcare.projects.locations.datasets.hl7V2Stores.messages.list", "type": "http" }, "http": { "method": "GET", "url": "https://healthcare.googleapis.com/v1beta1/:parent/messages", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "Required. Name of the HL7v2 store to retrieve messages from." }, { "name": "filter", "value": "", "type": "query", "description": "Restricts messages returned to those matching a filter. The following syntax is available: * A string field value can be written as text inside quotation marks, for example `\"query text\"`. The only valid relational operation for text fields is equality (`=`), where text is searched within the field, rather than having the field be equal to the text. For example, `\"Comment = great\"` returns messages with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. Fields/functions available for filtering are: * `message_type`, from the MSH-9.1 field. For example, `NOT message_type = \"ADT\"`. * `send_date` or `sendDate`, the YYYY-MM-DD date the message was sent in the dataset's time_zone, from the MSH-7 segment. For example, `send_date < \"2017-01-02\"`. * `send_time`, the timestamp when the message was sent, using the RFC3339 time format for comparisons, from the MSH-7 segment. For example, `send_time < \"2017-01-02T00:00:00-05:00\"`. * `create_time`, the timestamp when the message was created in the HL7v2 store. Use the RFC3339 time format for comparisons. For example, `create_time < \"2017-01-02T00:00:00-05:00\"`. * `send_facility`, the care center that the message came from, from the MSH-4 segment. For example, `send_facility = \"ABC\"`. * `PatientId(value, type)`, which matches if the message lists a patient having an ID of the given value and type in the PID-2, PID-3, or PID-4 segments. For example, `PatientId(\"123456\", \"MRN\")`. * `labels.x`, a string value of the label with key `x` as set using the Message.labels map. For example, `labels.\"priority\"=\"high\"`. The operator `:*` can be used to assert the existence of a label. For example, `labels.\"priority\":*`." }, { "name": "orderBy", "value": "", "type": "query", "description": "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`" }, { "name": "pageSize", "value": "", "type": "query", "description": "Limit on the number of messages to return in a single response. If not specified, 100 is used. May not be larger than 1000." }, { "name": "pageToken", "value": "", "type": "query", "description": "The next_page_token value returned from the previous List request, if any." }, { "name": "view", "value": "", "type": "query", "description": "Specifies the parts of the Message to return in the response. When unspecified, equivalent to BASIC. Setting this to anything other than BASIC with a `page_size` larger than the default can generate a large response, which impacts the performance of this method." } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "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." }, { "info": { "name": "healthcare.projects.locations.datasets.hl7V2Stores.messages.create", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1beta1/:parent/messages", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "Required. The name of the HL7v2 store this message belongs to." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "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." }, { "info": { "name": "healthcare.projects.locations.datasets.hl7V2Stores.messages.batchGet", "type": "http" }, "http": { "method": "GET", "url": "https://healthcare.googleapis.com/v1beta1/:parent/messages:batchGet", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "Required. Name of the HL7v2 store to retrieve messages from, in the format: `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7v2Stores/{hl7v2_store_id}`." }, { "name": "ids", "value": "", "type": "query", "description": "The resource id of the HL7v2 messages to retrieve in the format: `{message_id}`, where the full resource name is `{parent}/messages/{message_id}` A maximum of 100 messages can be retrieved in a batch. All 'ids' have to be under parent." }, { "name": "view", "value": "", "type": "query", "description": "Specifies the parts of the Messages resource to return in the response. When unspecified, equivalent to BASIC." } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Gets multiple messages in the given HL7v2 store." }, { "info": { "name": "healthcare.projects.locations.datasets.hl7V2Stores.messages.ingest", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1beta1/:parent/messages:ingest", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "Required. The name of the HL7v2 store this message belongs to." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "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 acknowledgmen" }, { "info": { "name": "healthcare.projects.locations.datasets.consentStores.userDataMappings.list", "type": "http" }, "http": { "method": "GET", "url": "https://healthcare.googleapis.com/v1beta1/:parent/userDataMappings", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "Required. Name of the consent store to retrieve User data mappings from." }, { "name": "filter", "value": "", "type": "query", "description": "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 with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. The fields available for filtering are: - data_id - user_id. For example, `filter=user_id=\\\"user123\\\"`. - archived - archive_time" }, { "name": "pageSize", "value": "", "type": "query", "description": "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." }, { "name": "pageToken", "value": "", "type": "query", "description": "Optional. Token to retrieve the next page of results, or empty to get the first page." } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Lists the User data mappings in the specified consent store." }, { "info": { "name": "healthcare.projects.locations.datasets.consentStores.userDataMappings.create", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1beta1/:parent/userDataMappings", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "parent", "value": "", "type": "path", "description": "Required. Name of the consent store." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Creates a new User data mapping in the parent consent store." }, { "info": { "name": "healthcare.projects.locations.datasets.hl7V2Stores.getIamPolicy", "type": "http" }, "http": { "method": "GET", "url": "https://healthcare.googleapis.com/v1beta1/:resource:getIamPolicy", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "resource", "value": "", "type": "path", "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field." }, { "name": "options.requestedPolicyVersion", "value": "", "type": "query", "description": "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](https://cloud.google.com/iam/help/conditions/resource-policies)." } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set." }, { "info": { "name": "healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.instances.getStorageInfo", "type": "http" }, "http": { "method": "GET", "url": "https://healthcare.googleapis.com/v1beta1/:resource:getStorageInfo", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "resource", "value": "", "type": "path", "description": "Required. The path of the resource for which the storage info is requested (for exaxmple for a DICOM Instance: `projects/{projectid}/datasets/{datasetid}/dicomStores/{dicomStoreId}/dicomWeb/studies/{study_uid}/series/{series_uid}/instances/{instance_uid}`)" } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "GetStorageInfo returns the storage info of the specified resource." }, { "info": { "name": "healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.setBlobStorageSettings", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1beta1/:resource:setBlobStorageSettings", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "resource", "value": "", "type": "path", "description": "Required. The path of the resource to update the blob storage settings in the format of `projects/{projectID}/datasets/{datasetID}/dicomStores/{dicomStoreID}/dicomWeb/studies/{studyUID}`, `projects/{projectID}/datasets/{datasetID}/dicomStores/{dicomStoreID}/dicomWeb/studies/{studyUID}/series/{seriesUID}/`, or `projects/{projectID}/datasets/{datasetID}/dicomStores/{dicomStoreID}/dicomWeb/studies/{studyUID}/series/{seriesUID}/instances/{instanceUID}`. If `filter_config` is specified, set the value of `resource` to the resource name of a DICOM store in the format `projects/{projectID}/datasets/{datasetID}/dicomStores/{dicomStoreID}`." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "SetBlobStorageSettings sets the blob storage settings of the specified resources." }, { "info": { "name": "healthcare.projects.locations.datasets.hl7V2Stores.setIamPolicy", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1beta1/:resource:setIamPolicy", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "resource", "value": "", "type": "path", "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors." }, { "info": { "name": "healthcare.projects.locations.datasets.hl7V2Stores.testIamPermissions", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1beta1/:resource:testIamPermissions", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "resource", "value": "", "type": "path", "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "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." }, { "info": { "name": "healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.getSeriesMetrics", "type": "http" }, "http": { "method": "GET", "url": "https://healthcare.googleapis.com/v1beta1/:series:getSeriesMetrics", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "series", "value": "", "type": "path", "description": "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}`." } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "GetSeriesMetrics returns metrics for a series." }, { "info": { "name": "healthcare.projects.locations.datasets.deidentify", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1beta1/:sourceDataset:deidentify", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "sourceDataset", "value": "", "type": "path", "description": "Required. Source dataset resource name. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "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. The LRO result may still be successful if de-identification fails for some resources. The new de-identified dataset will not contain these failed resources. The number of resources processed are tracked in Operation.metadata. Error details are logged to Cloud Logging. For more information, see [Viewi" }, { "info": { "name": "healthcare.projects.locations.datasets.fhirStores.deidentify", "type": "http" }, "http": { "method": "POST", "url": "https://healthcare.googleapis.com/v1beta1/:sourceStore:deidentify", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "sourceStore", "value": "", "type": "path", "description": "Required. Source FHIR store resource name. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "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. The number of resources processed are tracked in Operation.metadata. Error details are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)." }, { "info": { "name": "healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.getStudyMetrics", "type": "http" }, "http": { "method": "GET", "url": "https://healthcare.googleapis.com/v1beta1/:study:getStudyMetrics", "params": [ { "name": "$.xgafv", "value": "", "type": "query", "description": "V1 error format." }, { "name": "access_token", "value": "", "type": "query", "description": "OAuth access token." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for response." }, { "name": "callback", "value": "", "type": "query", "description": "JSONP" }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying which fields to include in a partial response." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "oauth_token", "value": "", "type": "query", "description": "OAuth 2.0 token for the current user." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks." }, { "name": "quotaUser", "value": "", "type": "query", "description": "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." }, { "name": "upload_protocol", "value": "", "type": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, { "name": "uploadType", "value": "", "type": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, { "name": "study", "value": "", "type": "path", "description": "Required. The study resource path. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}/dicomWeb/studies/{study_uid}`." } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.google.com/o/oauth2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "GetStudyMetrics returns metrics for a study." } ] } ], "bundled": true }