openapi: 3.0.0 info: contact: name: Google url: https://google.com x-twitter: youtube description: Manage, store, and access healthcare data in Google Cloud Platform. license: name: Creative Commons Attribution 3.0 url: http://creativecommons.org/licenses/by/3.0/ termsOfService: https://developers.google.com/terms/ title: Cloud Healthcare projects API version: v1 x-apiClientRegistration: url: https://console.developers.google.com x-apisguru-categories: - analytics - media x-logo: url: https://www.google.com/images/branding/googlelogo/2x/googlelogo_color_272x92dp.png x-origin: - format: google url: https://healthcare.googleapis.com/$discovery/rest?version=v1 version: v1 x-preferred: false x-providerName: googleapis.com x-serviceName: healthcare servers: - url: https://healthcare.googleapis.com/ tags: - name: projects paths: /v1/{consentStore}:checkDataAccess: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' post: description: Checks if a particular data_id of a User data mapping in the specified consent store is consented for the specified use. operationId: healthcare.projects.locations.datasets.consentStores.checkDataAccess parameters: - 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}`. in: path name: consentStore required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CheckDataAccessRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CheckDataAccessResponse' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1/{consentStore}:evaluateUserConsents: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' post: description: '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.' operationId: healthcare.projects.locations.datasets.consentStores.evaluateUserConsents parameters: - description: Required. Name of the consent store to retrieve User data mappings from. in: path name: consentStore required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/EvaluateUserConsentsRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/EvaluateUserConsentsResponse' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1/{consentStore}:queryAccessibleData: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' post: description: 'Queries all data_ids that are consented for a specified use in the given consent store and writes them to a specified destination. The returned Operation includes a progress counter for the number of User data mappings processed. If the request is successful, a detailed response is returned of type QueryAccessibleDataResponse, contained in the response field when the operation finishes. The metadata field type is OperationMetadata. Errors are logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). For example, the following sample log entry shows a `failed to evaluate consent policy` error that occurred during a QueryAccessibleData call to consent store `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}`. ```json jsonPayload: { @type: "type.googleapis.com/google.cloud.healthcare.logging.QueryAccessibleDataLogEntry" error: { code: 9 message: "failed to evaluate consent policy" } resourceName: "projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}" } logName: "projects/{project_id}/logs/healthcare.googleapis.com%2Fquery_accessible_data" operation: { id: "projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/operations/{operation_id}" producer: "healthcare.googleapis.com/QueryAccessibleData" } receiveTimestamp: "TIMESTAMP" resource: { labels: { consent_store_id: "{consent_store_id}" dataset_id: "{dataset_id}" location: "{location_id}" project_id: "{project_id}" } type: "healthcare_consent_store" } severity: "ERROR" timestamp: "TIMESTAMP" ```' operationId: healthcare.projects.locations.datasets.consentStores.queryAccessibleData parameters: - description: Required. Name of the consent store to retrieve User data mappings from. in: path name: consentStore required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/QueryAccessibleDataRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Operation' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1/{name}: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' delete: description: Deletes an HL7v2 message. operationId: healthcare.projects.locations.datasets.hl7V2Stores.messages.delete parameters: - description: Required. The resource name of the HL7v2 message to delete. in: path name: name required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/Empty' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects get: description: 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. operationId: healthcare.projects.locations.datasets.operations.get parameters: - description: The name of the operation resource. in: path name: name required: true schema: type: string - description: Specifies which parts of the Message resource to return in the response. When unspecified, equivalent to FULL. in: query name: view schema: enum: - MESSAGE_VIEW_UNSPECIFIED - RAW_ONLY - PARSED_ONLY - FULL - SCHEMATIZED_ONLY - BASIC type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/Operation' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects patch: description: 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. operationId: healthcare.projects.locations.datasets.hl7V2Stores.messages.patch parameters: - 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. in: path name: name required: true schema: type: string - 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 in: query name: updateMask schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Message' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Message' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects put: description: 'Updates the entire contents of a resource. Implements the FHIR standard update interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#update), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#update), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#update)). If the specified resource does not exist and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. The resource must contain an `id` element having an identical value to the ID in the REST path of the request. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `update`, see [Updating a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#updating_a_fhir_resource).' operationId: healthcare.projects.locations.datasets.fhirStores.fhir.update parameters: - description: Required. The name of the resource to update. in: path name: name required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/HttpBody' responses: '200': content: application/json: schema: $ref: '#/components/schemas/HttpBody' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1/{name}/$everything: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' get: description: 'Retrieves a Patient resource and resources related to that patient. Implements the FHIR extended operation Patient-everything ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/patient-operations.html#everything), [STU3](http://hl7.org/implement/standards/fhir/STU3/patient-operations.html#everything), [R4](http://hl7.org/implement/standards/fhir/R4/patient-operations.html#everything)). On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the operation. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The resources in scope for the response are: * The patient resource itself. * All the resources directly referenced by the patient resource. * Resources directly referencing the patient resource that meet the inclusion criteria. The inclusion criteria are based on the membership rules in the patient compartment definition ([DSTU2](http://hl7.org/fhir/DSTU2/compartment-patient.html), [STU3](http://www.hl7.org/fhir/stu3/compartmentdefinition-patient.html), [R4](http://hl7.org/fhir/R4/compartmentdefinition-patient.html)), which details the eligible resource types and referencing search parameters. For samples that show how to call `Patient-everything`, see [Getting all patient compartment resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#getting_all_patient_compartment_resources).' operationId: healthcare.projects.locations.datasets.fhirStores.fhir.Patient-everything parameters: - description: Required. Name of the `Patient` resource for which the information is required. in: path name: name required: true schema: type: string - description: Optional. Maximum number of resources in a page. If not specified, 100 is used. May not be larger than 1000. in: query name: _count schema: type: integer - 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. in: query name: _page_token schema: type: string - 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. in: query name: _since schema: type: string - 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. in: query name: _type schema: type: string - 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. in: query name: end schema: type: string - 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. in: query name: start schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/HttpBody' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1/{name}/$purge: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' delete: description: 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). operationId: healthcare.projects.locations.datasets.fhirStores.fhir.Resource-purge parameters: - description: Required. The name of the resource to purge. in: path name: name required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/Empty' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1/{name}/_history: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' get: description: Lists all the versions of a resource (including the current version and deleted versions) from the FHIR store. Implements the per-resource form of the FHIR standard history interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#history), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#history), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#history)). On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `history`, containing the version history sorted from most recent to oldest versions. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `history`, see [Listing FHIR resource versions](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#listing_fhir_resource_versions). operationId: healthcare.projects.locations.datasets.fhirStores.fhir.history parameters: - description: Required. The name of the resource to retrieve. in: path name: name required: true schema: type: string - 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`' in: query name: _at schema: type: string - description: The maximum number of search results on a page. If not specified, 100 is used. May not be larger than 1000. in: query name: _count schema: type: integer - 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. in: query name: _page_token schema: type: string - 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. in: query name: _since schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/HttpBody' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1/{name}/fhir/metadata: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' get: description: Gets the FHIR capability statement ([STU3](http://hl7.org/implement/standards/fhir/STU3/capabilitystatement.html), [R4](http://hl7.org/implement/standards/fhir/R4/capabilitystatement.html)), or the [conformance statement](http://hl7.org/implement/standards/fhir/DSTU2/conformance.html) in the DSTU2 case for the store, which contains a description of functionality supported by the server. Implements the FHIR standard capabilities interaction ([STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#capabilities), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#capabilities)), or the [conformance interaction](http://hl7.org/implement/standards/fhir/DSTU2/http.html#conformance) in the DSTU2 case. On success, the response body contains a JSON-encoded representation of a `CapabilityStatement` resource. operationId: healthcare.projects.locations.datasets.fhirStores.fhir.capabilities parameters: - description: Required. Name of the FHIR store to retrieve the capabilities for. in: path name: name required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/HttpBody' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1/{name}/locations: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' get: description: Lists information about the supported locations for this service. operationId: healthcare.projects.locations.list parameters: - description: The resource that owns the locations collection, if applicable. in: path name: name required: true schema: type: string - 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). in: query name: filter schema: type: string - description: The maximum number of results to return. If not set, the service selects a default. in: query name: pageSize schema: type: integer - description: A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. in: query name: pageToken schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListLocationsResponse' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1/{name}/operations: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' get: description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. operationId: healthcare.projects.locations.datasets.operations.list parameters: - description: The name of the operation's parent resource. in: path name: name required: true schema: type: string - description: The standard list filter. in: query name: filter schema: type: string - description: The standard list page size. in: query name: pageSize schema: type: integer - description: The standard list page token. in: query name: pageToken schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListOperationsResponse' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1/{name}:activate: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' post: description: 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. operationId: healthcare.projects.locations.datasets.consentStores.consents.activate parameters: - 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. in: path name: name required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ActivateConsentRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Consent' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1/{name}:archive: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' post: description: Archives the specified User data mapping. operationId: healthcare.projects.locations.datasets.consentStores.userDataMappings.archive parameters: - description: Required. The resource name of the User data mapping to archive. in: path name: name required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ArchiveUserDataMappingRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/ArchiveUserDataMappingResponse' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1/{name}:cancel: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' post: description: Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. operationId: healthcare.projects.locations.datasets.operations.cancel parameters: - description: The name of the operation resource to be cancelled. in: path name: name required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CancelOperationRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Empty' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1/{name}:deleteRevision: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' delete: description: Deletes the specified revision of a Consent. An INVALID_ARGUMENT error occurs if the specified revision is the latest revision. operationId: healthcare.projects.locations.datasets.consentStores.consents.deleteRevision parameters: - 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. in: path name: name required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/Empty' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1/{name}:export: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' post: description: Exports the messages to a destination. To filter messages to be exported, define a filter using the start and end time, relative to the message generation time (MSH.7). This API returns an Operation that can be used to track the status of the job by calling GetOperation. Immediate fatal errors appear in the error field. Otherwise, when the operation finishes, a detailed response of type ExportMessagesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata. operationId: healthcare.projects.locations.datasets.hl7V2Stores.export parameters: - 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}` in: path name: name required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ExportMessagesRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Operation' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1/{name}:getDICOMStoreMetrics: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' get: description: Gets metrics associated with the DICOM store. operationId: healthcare.projects.locations.datasets.dicomStores.getDICOMStoreMetrics parameters: - description: Required. The resource name of the DICOM store to get metrics for. in: path name: name required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/DicomStoreMetrics' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1/{name}:getFHIRStoreMetrics: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' get: description: Gets metrics associated with the FHIR store. operationId: healthcare.projects.locations.datasets.fhirStores.getFHIRStoreMetrics parameters: - description: Required. The resource name of the FHIR store to get metrics for. in: path name: name required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/FhirStoreMetrics' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1/{name}:getHL7v2StoreMetrics: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' get: description: Gets metrics associated with the HL7v2 store. operationId: healthcare.projects.locations.datasets.hl7V2Stores.getHL7v2StoreMetrics parameters: - 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}`. in: path name: name required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/Hl7V2StoreMetrics' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1/{name}:import: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' post: description: Import messages to the HL7v2 store by loading data from the specified sources. This method is optimized to load large quantities of data using import semantics that ignore some HL7v2 store configuration options and are not suitable for all use cases. It is primarily intended to load data into an empty HL7v2 store that is not being used by other clients. An existing message will be overwritten if a duplicate message is imported. A duplicate message is a message with the same raw bytes as a message that already exists in this HL7v2 store. When a message is overwritten, its labels will also be overwritten. The import operation is idempotent unless the input data contains multiple valid messages with the same raw bytes but different labels. In that case, after the import completes, the store contains exactly one message with those raw bytes but there is no ordering guarantee on which version of the labels it has. The operation result counters do not count duplicated raw bytes as an error and count one success for each message in the input, which might result in a success count larger than the number of messages in the HL7v2 store. If some messages fail to import, for example due to parsing errors, successfully imported messages are not rolled back. This method returns an Operation that can be used to track the status of the import by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). Otherwise, when the operation finishes, a response of type ImportMessagesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata. operationId: healthcare.projects.locations.datasets.hl7V2Stores.import parameters: - 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}` in: path name: name required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ImportMessagesRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Operation' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1/{name}:listRevisions: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' get: description: Lists the revisions of the specified Consent in reverse chronological order. operationId: healthcare.projects.locations.datasets.consentStores.consents.listRevisions parameters: - description: Required. The resource name of the Consent to retrieve revisions for. in: path name: name required: true schema: type: string - 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\")`.' in: query name: filter schema: type: string - 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. in: query name: pageSize schema: type: integer - description: Optional. Token to retrieve the next page of results or empty if there are no more results in the list. in: query name: pageToken schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListConsentRevisionsResponse' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1/{name}:reject: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' post: description: 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. operationId: healthcare.projects.locations.datasets.consentStores.consents.reject parameters: - 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. in: path name: name required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/RejectConsentRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Consent' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1/{name}:revoke: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' post: description: 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. operationId: healthcare.projects.locations.datasets.consentStores.consents.revoke parameters: - 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. in: path name: name required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/RevokeConsentRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Consent' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1/{name}:rollback: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' post: description: Rolls back resources from the FHIR store to the specified time. This method returns an Operation that can be used to track the status of the rollback by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). Otherwise, when the operation finishes, a detailed response of type RollbackFhirResourcesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata. operationId: healthcare.projects.locations.datasets.fhirStores.rollback parameters: - 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}". in: path name: name required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/RollbackFhirResourcesRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Operation' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1/{nlpService}:analyzeEntities: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' post: description: 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. operationId: healthcare.projects.locations.services.nlp.analyzeEntities parameters: - description: 'The resource name of the service of the form: "projects/{project_id}/locations/{location_id}/services/nlp".' in: path name: nlpService required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AnalyzeEntitiesRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/AnalyzeEntitiesResponse' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1/{parent}/attributeDefinitions: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' get: description: Lists the Attribute definitions in the specified consent store. operationId: healthcare.projects.locations.datasets.consentStores.attributeDefinitions.list parameters: - description: Required. Name of the consent store to retrieve Attribute definitions from. in: path name: parent required: true schema: type: string - description: Optional. Restricts the attributes returned to those matching a filter. The only field available for filtering is `category`. For example, `filter=category=\"REQUEST\"`. in: query name: filter schema: type: string - 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. in: query name: pageSize schema: type: integer - description: Optional. Token to retrieve the next page of results or empty to get the first page. in: query name: pageToken schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListAttributeDefinitionsResponse' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects post: description: Creates a new Attribute definition in the parent consent store. operationId: healthcare.projects.locations.datasets.consentStores.attributeDefinitions.create parameters: - description: Required. The name of the consent store that this Attribute definition belongs to. in: path name: parent required: true schema: type: string - 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.' in: query name: attributeDefinitionId schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AttributeDefinition' responses: '200': content: application/json: schema: $ref: '#/components/schemas/AttributeDefinition' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1/{parent}/consentArtifacts: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' get: description: Lists the Consent artifacts in the specified consent store. operationId: healthcare.projects.locations.datasets.consentStores.consentArtifacts.list parameters: - description: Required. Name of the consent store to retrieve consent artifacts from. in: path name: parent required: true schema: type: string - 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\")`.' in: query name: filter schema: type: string - 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. in: query name: pageSize schema: type: integer - description: Optional. The next_page_token value returned from the previous List request, if any. in: query name: pageToken schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListConsentArtifactsResponse' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects post: description: Creates a new Consent artifact in the parent consent store. operationId: healthcare.projects.locations.datasets.consentStores.consentArtifacts.create parameters: - description: Required. The name of the consent store this Consent artifact belongs to. in: path name: parent required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ConsentArtifact' responses: '200': content: application/json: schema: $ref: '#/components/schemas/ConsentArtifact' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1/{parent}/consentStores: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' get: description: Lists the consent stores in the specified dataset. operationId: healthcare.projects.locations.datasets.consentStores.list parameters: - description: Required. Name of the dataset. in: path name: parent required: true schema: type: string - description: Optional. Restricts the stores returned to those matching a filter. Only filtering on labels is supported. For example, `filter=labels.key=value`. in: query name: filter schema: type: string - 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. in: query name: pageSize schema: type: integer - description: Optional. Token to retrieve the next page of results, or empty to get the first page. in: query name: pageToken schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListConsentStoresResponse' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects post: description: 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. operationId: healthcare.projects.locations.datasets.consentStores.create parameters: - description: Required. The name of the dataset this consent store belongs to. in: path name: parent required: true schema: type: string - 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.' in: query name: consentStoreId schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ConsentStore' responses: '200': content: application/json: schema: $ref: '#/components/schemas/ConsentStore' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1/{parent}/consents: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' get: description: Lists the Consent in the given consent store, returning each Consent's latest revision. operationId: healthcare.projects.locations.datasets.consentStores.consents.list parameters: - description: Required. Name of the consent store to retrieve Consents from. in: path name: parent required: true schema: type: string - 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\")`.' in: query name: filter schema: type: string - 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. in: query name: pageSize schema: type: integer - description: Optional. The next_page_token value returned from the previous List request, if any. in: query name: pageToken schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListConsentsResponse' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects post: description: Creates a new Consent in the parent consent store. operationId: healthcare.projects.locations.datasets.consentStores.consents.create parameters: - description: Required. Name of the consent store. in: path name: parent required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Consent' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Consent' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1/{parent}/datasets: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' get: description: Lists the health datasets in the current project. operationId: healthcare.projects.locations.datasets.list parameters: - description: Required. The name of the project whose datasets should be listed. For example, `projects/{project_id}/locations/{location_id}`. in: path name: parent required: true schema: type: string - description: The maximum number of items to return. If not specified, 100 is used. May not be larger than 1000. in: query name: pageSize schema: type: integer - description: The next_page_token value returned from a previous List request, if any. in: query name: pageToken schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListDatasetsResponse' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects post: description: 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. operationId: healthcare.projects.locations.datasets.create parameters: - description: Required. The name of the project where the server creates the dataset. For example, `projects/{project_id}/locations/{location_id}`. in: path name: parent required: true schema: type: string - description: 'Required. The ID of the dataset that is being created. The string must match the following regex: `[\p{L}\p{N}_\-\.]{1,256}`.' in: query name: datasetId schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Dataset' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Operation' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1/{parent}/dicomStores: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' get: description: Lists the DICOM stores in the given dataset. operationId: healthcare.projects.locations.datasets.dicomStores.list parameters: - description: Required. Name of the dataset. in: path name: parent required: true schema: type: string - 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`.' in: query name: filter schema: type: string - 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. in: query name: pageSize schema: type: integer - description: The next_page_token value returned from the previous List request, if any. in: query name: pageToken schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListDicomStoresResponse' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects post: description: Creates a new DICOM store within the parent dataset. operationId: healthcare.projects.locations.datasets.dicomStores.create parameters: - description: Required. The name of the dataset this DICOM store belongs to. in: path name: parent required: true schema: type: string - description: Required. The ID of the DICOM store that is being created. Any string value up to 256 characters in length. in: query name: dicomStoreId schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/DicomStore' responses: '200': content: application/json: schema: $ref: '#/components/schemas/DicomStore' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1/{parent}/dicomWeb/{dicomWebPath}: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' delete: description: 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). operationId: healthcare.projects.locations.datasets.dicomStores.studies.series.instances.delete parameters: - 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}`. in: path name: parent required: true schema: type: string - description: Required. The path of the DeleteInstance request. For example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}`. in: path name: dicomWebPath required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/Empty' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects get: description: RetrieveRenderedFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers in an acceptable Rendered Media Type. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedFrames, see [Rendered resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedFrames, see [Retrieve consumer image formats](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-consumer). operationId: healthcare.projects.locations.datasets.dicomStores.studies.series.instances.frames.retrieveRendered parameters: - 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}`. in: path name: parent required: true schema: type: string - description: Required. The path of the RetrieveRenderedFrames DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}/frames/{frame_list}/rendered`. in: path name: dicomWebPath required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/HttpBody' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects post: description: StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). For details on the implementation of StoreInstances, see [Store transaction](https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see [Store DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#store-dicom). operationId: healthcare.projects.locations.datasets.dicomStores.studies.storeInstances parameters: - 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}`. in: path name: parent required: true schema: type: string - description: Required. The path of the StoreInstances DICOMweb request. For example, `studies/[{study_uid}]`. Note that the `study_uid` is optional. in: path name: dicomWebPath required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/HttpBody' responses: '200': content: application/json: schema: $ref: '#/components/schemas/HttpBody' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1/{parent}/fhir: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' post: description: 'Executes all the requests in the given Bundle. Implements the FHIR standard batch/transaction interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#transaction), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#transaction), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#transaction)). Supports all interactions within a bundle, except search. This method accepts Bundles of type `batch` and `transaction`, processing them according to the batch processing rules ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.1), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.1), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#brules)) and transaction processing rules ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.2), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.2), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#trules)). The request body must contain a JSON-encoded FHIR `Bundle` resource, and the request headers must contain `Content-Type: application/fhir+json`. For a batch bundle or a successful transaction, the response body contains a JSON-encoded representation of a `Bundle` resource of type `batch-response` or `transaction-response` containing one entry for each entry in the request, with the outcome of processing the entry. In the case of an error for a transaction bundle, the response body contains a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. This method checks permissions for each request in the bundle. The `executeBundle` permission is required to call this method, but you must also grant sufficient permissions to execute the individual requests in the bundle. For example, if the bundle contains a request to create a FHIR resource, the caller must also have been granted the `healthcare.fhirResources.create` permission. You can use audit logs to view the permissions for `executeBundle` and each request in the bundle. For more information, see [Viewing Cloud Audit logs](https://cloud.google.com/healthcare-api/docs/how-tos/audit-logging). For samples that show how to call `executeBundle`, see [Managing FHIR resources using FHIR bundles](https://cloud.google.com/healthcare/docs/how-tos/fhir-bundles).' operationId: healthcare.projects.locations.datasets.fhirStores.fhir.executeBundle parameters: - description: Required. Name of the FHIR store in which this bundle will be executed. in: path name: parent required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/HttpBody' responses: '200': content: application/json: schema: $ref: '#/components/schemas/HttpBody' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1/{parent}/fhir/_search: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' post: description: 'Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#search), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#search), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/search.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/search.html), [R4](http://hl7.org/implement/standards/fhir/R4/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server''s capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](http://hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html), [R4](http://hl7.org/implement/standards/fhir/R4/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource''s definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned `Bundle` contains a link of `relation` "next", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any of the following search result parameters can be used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn''t optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the default sorting order. Note: The special synchronous identifier index are currently disabled for DocumentReference and DocumentManifest searches. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).' operationId: healthcare.projects.locations.datasets.fhirStores.fhir.search parameters: - description: Required. Name of the FHIR store to retrieve resources from. in: path name: parent required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SearchResourcesRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/HttpBody' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1/{parent}/fhir/{resourceType}/_search: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' post: description: 'Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#search), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#search), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/search.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/search.html), [R4](http://hl7.org/implement/standards/fhir/R4/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server''s capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](http://hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html), [R4](http://hl7.org/implement/standards/fhir/R4/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource''s definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned `Bundle` contains a link of `relation` "next", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any of the following search result parameters can be used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn''t optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the default sorting order. Note: The special synchronous identifier index are currently disabled for DocumentReference and DocumentManifest searches. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).' operationId: healthcare.projects.locations.datasets.fhirStores.fhir.search-type parameters: - description: Required. Name of the FHIR store to retrieve resources from. in: path name: parent required: true schema: type: string - 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)). in: path name: resourceType required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SearchResourcesRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/HttpBody' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1/{parent}/fhir/{type}: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' delete: description: 'Deletes a FHIR resource that match an identifier search query. Implements the FHIR standard conditional delete interaction, limited to searching by resource identifier. If multiple resources match, 412 Precondition Failed error will be returned. Search term for identifier should be in the pattern `identifier=system|value` or `identifier=value` - similar to the `search` method on resources with a specific identifier. Note: Unless resource versioning is disabled by setting the disable_resource_versioning flag on the FHIR store, the deleted resource is moved to a history repository that can still be retrieved through vread and related methods, unless they are removed by the purge method. For samples that show how to call `conditionalDelete`, see [Conditionally deleting a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#conditionally_deleting_a_fhir_resource).' operationId: healthcare.projects.locations.datasets.fhirStores.fhir.conditionalDelete parameters: - description: Required. The name of the FHIR store this resource belongs to. in: path name: parent required: true schema: type: string - 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)). in: path name: type required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/Empty' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects patch: description: 'If a resource is found with the identifier specified in the query parameters, updates part of that resource by applying the operations specified in a [JSON Patch](http://jsonpatch.com/) document. Implements the FHIR standard conditional patch interaction, limited to searching by resource identifier. DSTU2 doesn''t define a conditional patch method, but the server supports it in the same way it supports STU3. Search term for identifier should be in the pattern `identifier=system|value` or `identifier=value` - similar to the `search` method on resources with a specific identifier. If the search criteria identify more than one match, the request returns a `412 Precondition Failed` error. The request body must contain a JSON Patch document, and the request headers must contain `Content-Type: application/json-patch+json`. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `conditionalPatch`, see [Conditionally patching a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#conditionally_patching_a_fhir_resource).' operationId: healthcare.projects.locations.datasets.fhirStores.fhir.conditionalPatch parameters: - description: Required. The name of the FHIR store this resource belongs to. in: path name: parent required: true schema: type: string - 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)). in: path name: type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/HttpBody' responses: '200': content: application/json: schema: $ref: '#/components/schemas/HttpBody' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects post: description: 'Creates a FHIR resource. Implements the FHIR standard create interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#create), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#create), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#create)), which creates a new resource with a server-assigned resource ID. Also supports the FHIR standard conditional create interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#ccreate), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#ccreate), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#ccreate)), specified by supplying an `If-None-Exist` header containing a FHIR search query, limited to searching by resource identifier. If no resources match this search query, the server processes the create operation as normal. When using conditional create, the search term for identifier should be in the pattern `identifier=system|value` or `identifier=value` - similar to the `search` method on resources with a specific identifier. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. On success, the response body contains a JSON-encoded representation of the resource as it was created on the server, including the server-assigned resource ID and version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `create`, see [Creating a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#creating_a_fhir_resource).' operationId: healthcare.projects.locations.datasets.fhirStores.fhir.create parameters: - description: Required. The name of the FHIR store this resource belongs to. in: path name: parent required: true schema: type: string - 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. in: path name: type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/HttpBody' responses: '200': content: application/json: schema: $ref: '#/components/schemas/HttpBody' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects put: description: 'If a resource is found with the identifier specified in the query parameters, updates the entire contents of that resource. Implements the FHIR standard conditional update interaction, limited to searching by resource identifier. Search term for identifier should be in the pattern `identifier=system|value` or `identifier=value` - similar to the `search` method on resources with a specific identifier. If the search criteria identify more than one match, the request returns a `412 Precondition Failed` error. If the search criteria identify zero matches, and the supplied resource body contains an `id`, and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. If the search criteria identify zero matches, and the supplied resource body does not contain an `id`, the resource is created with a server-assigned ID as per the create method. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `conditionalUpdate`, see [Conditionally updating a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#conditionally_updating_a_fhir_resource).' operationId: healthcare.projects.locations.datasets.fhirStores.fhir.conditionalUpdate parameters: - description: Required. The name of the FHIR store this resource belongs to. in: path name: parent required: true schema: type: string - 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. in: path name: type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/HttpBody' responses: '200': content: application/json: schema: $ref: '#/components/schemas/HttpBody' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1/{parent}/fhir/{type}/$validate: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' post: description: 'Validates an input FHIR resource''s conformance to its profiles and the profiles configured on the FHIR store. Implements the FHIR extended operation $validate ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resource-operations.html#validate), [STU3](http://hl7.org/implement/standards/fhir/STU3/resource-operations.html#validate), or [R4](http://hl7.org/implement/standards/fhir/R4/resource-operation-validate.html)). The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. The `Parameters` input syntax is not supported. The `profile` query parameter can be used to request that the resource only be validated against a specific profile. If a profile with the given URL cannot be found in the FHIR store then an error is returned. Errors generated by validation contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead.' operationId: healthcare.projects.locations.datasets.fhirStores.fhir.Resource-validate parameters: - description: Required. The name of the FHIR store that holds the profiles being used for validation. in: path name: parent required: true schema: type: string - 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. in: path name: type required: true schema: type: string - 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. in: query name: profile schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/HttpBody' responses: '200': content: application/json: schema: $ref: '#/components/schemas/HttpBody' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1/{parent}/fhirStores: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' get: description: Lists the FHIR stores in the given dataset. operationId: healthcare.projects.locations.datasets.fhirStores.list parameters: - description: Required. Name of the dataset. in: path name: parent required: true schema: type: string - 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`.' in: query name: filter schema: type: string - 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. in: query name: pageSize schema: type: integer - description: The next_page_token value returned from the previous List request, if any. in: query name: pageToken schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListFhirStoresResponse' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects post: description: Creates a new FHIR store within the parent dataset. operationId: healthcare.projects.locations.datasets.fhirStores.create parameters: - description: Required. The name of the dataset this FHIR store belongs to. in: path name: parent required: true schema: type: string - 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}`.' in: query name: fhirStoreId schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FhirStore' responses: '200': content: application/json: schema: $ref: '#/components/schemas/FhirStore' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1/{parent}/hl7V2Stores: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' get: description: Lists the HL7v2 stores in the given dataset. operationId: healthcare.projects.locations.datasets.hl7V2Stores.list parameters: - description: Required. Name of the dataset. in: path name: parent required: true schema: type: string - 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`.' in: query name: filter schema: type: string - 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. in: query name: pageSize schema: type: integer - description: The next_page_token value returned from the previous List request, if any. in: query name: pageToken schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListHl7V2StoresResponse' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects post: description: Creates a new HL7v2 store within the parent dataset. operationId: healthcare.projects.locations.datasets.hl7V2Stores.create parameters: - description: Required. The name of the dataset this HL7v2 store belongs to. in: path name: parent required: true schema: type: string - 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}`.' in: query name: hl7V2StoreId schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Hl7V2Store' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Hl7V2Store' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1/{parent}/messages: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' get: description: '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.' operationId: healthcare.projects.locations.datasets.hl7V2Stores.messages.list parameters: - description: Required. Name of the HL7v2 store to retrieve messages from. in: path name: parent required: true schema: type: string - 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":*`.' in: query name: filter schema: type: string - 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`' in: query name: orderBy schema: type: string - 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. in: query name: pageSize schema: type: integer - description: The next_page_token value returned from the previous List request, if any. in: query name: pageToken schema: type: string - 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. in: query name: view schema: enum: - MESSAGE_VIEW_UNSPECIFIED - RAW_ONLY - PARSED_ONLY - FULL - SCHEMATIZED_ONLY - BASIC type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListMessagesResponse' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects post: description: 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. operationId: healthcare.projects.locations.datasets.hl7V2Stores.messages.create parameters: - description: Required. The name of the HL7v2 store this message belongs to. in: path name: parent required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateMessageRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Message' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1/{parent}/messages:ingest: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' post: description: Parses and stores an HL7v2 message. This method triggers an asynchronous notification to any Pub/Sub topic configured in Hl7V2Store.Hl7V2NotificationConfig, if the filtering matches the message. If an MLLP adapter is configured to listen to a Pub/Sub topic, the adapter transmits the message when a notification is received. If the method is successful, it generates a response containing an HL7v2 acknowledgment (`ACK`) message. If the method encounters an error, it returns a negative acknowledgment (`NACK`) message. This behavior is suitable for replying to HL7v2 interface systems that expect these acknowledgments. operationId: healthcare.projects.locations.datasets.hl7V2Stores.messages.ingest parameters: - description: Required. The name of the HL7v2 store this message belongs to. in: path name: parent required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/IngestMessageRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/IngestMessageResponse' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1/{parent}/userDataMappings: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' get: description: Lists the User data mappings in the specified consent store. operationId: healthcare.projects.locations.datasets.consentStores.userDataMappings.list parameters: - description: Required. Name of the consent store to retrieve User data mappings from. in: path name: parent required: true schema: type: string - 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' in: query name: filter schema: type: string - 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. in: query name: pageSize schema: type: integer - description: Optional. Token to retrieve the next page of results, or empty to get the first page. in: query name: pageToken schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListUserDataMappingsResponse' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects post: description: Creates a new User data mapping in the parent consent store. operationId: healthcare.projects.locations.datasets.consentStores.userDataMappings.create parameters: - description: Required. Name of the consent store. in: path name: parent required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UserDataMapping' responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserDataMapping' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1/{resource}:getIamPolicy: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' get: description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. operationId: healthcare.projects.locations.datasets.hl7V2Stores.getIamPolicy parameters: - 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.' in: path name: resource required: true schema: type: string - 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). in: query name: options.requestedPolicyVersion schema: type: integer responses: '200': content: application/json: schema: $ref: '#/components/schemas/Policy' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1/{resource}:setIamPolicy: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' post: description: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. operationId: healthcare.projects.locations.datasets.hl7V2Stores.setIamPolicy parameters: - 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.' in: path name: resource required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SetIamPolicyRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Policy' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1/{resource}:testIamPermissions: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' post: description: '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.' operationId: healthcare.projects.locations.datasets.hl7V2Stores.testIamPermissions parameters: - 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.' in: path name: resource required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/TestIamPermissionsRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/TestIamPermissionsResponse' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1/{series}:getSeriesMetrics: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' get: description: GetSeriesMetrics returns metrics for a series. operationId: healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.getSeriesMetrics parameters: - 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}`. in: path name: series required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/SeriesMetrics' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1/{sourceDataset}:deidentify: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' post: description: Creates a new dataset containing de-identified data from the source dataset. The metadata field type is OperationMetadata. If the request is successful, the response field type is DeidentifySummary. If errors occur, error is set. The LRO result may still be successful if de-identification fails for some DICOM instances. The new de-identified dataset will not contain these failed resources. Failed resource totals are tracked in Operation.metadata. Error details are also logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging). operationId: healthcare.projects.locations.datasets.deidentify parameters: - description: Required. Source dataset resource name. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`. in: path name: sourceDataset required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/DeidentifyDatasetRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Operation' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1/{sourceStore}:deidentify: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' post: description: 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)). operationId: healthcare.projects.locations.datasets.fhirStores.deidentify parameters: - description: Required. Source FHIR store resource name. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. in: path name: sourceStore required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/DeidentifyFhirStoreRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Operation' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1/{study}:getStudyMetrics: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' get: description: GetStudyMetrics returns metrics for a study. operationId: healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.getStudyMetrics parameters: - 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}`. in: path name: study required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/StudyMetrics' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1beta1/{consentStore}:checkDataAccess: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' post: description: Checks if a particular data_id of a User data mapping in the specified consent store is consented for the specified use. operationId: healthcare.projects.locations.datasets.consentStores.checkDataAccess parameters: - 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}`. in: path name: consentStore required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CheckDataAccessRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CheckDataAccessResponse' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1beta1/{consentStore}:evaluateUserConsents: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' post: description: '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.' operationId: healthcare.projects.locations.datasets.consentStores.evaluateUserConsents parameters: - description: Required. Name of the consent store to retrieve User data mappings from. in: path name: consentStore required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/EvaluateUserConsentsRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/EvaluateUserConsentsResponse' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1beta1/{consentStore}:queryAccessibleData: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' post: description: 'Queries all data_ids that are consented for a specified use in the given consent store and writes them to a specified destination. The returned Operation includes a progress counter for the number of User data mappings processed. If the request is successful, a detailed response is returned of type QueryAccessibleDataResponse, contained in the response field when the operation finishes. The metadata field type is OperationMetadata. Errors are logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). For example, the following sample log entry shows a `failed to evaluate consent policy` error that occurred during a QueryAccessibleData call to consent store `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}`. ```json jsonPayload: { @type: "type.googleapis.com/google.cloud.healthcare.logging.QueryAccessibleDataLogEntry" error: { code: 9 message: "failed to evaluate consent policy" } resourceName: "projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}" } logName: "projects/{project_id}/logs/healthcare.googleapis.com%2Fquery_accessible_data" operation: { id: "projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/operations/{operation_id}" producer: "healthcare.googleapis.com/QueryAccessibleData" } receiveTimestamp: "TIMESTAMP" resource: { labels: { consent_store_id: "{consent_store_id}" dataset_id: "{dataset_id}" location: "{location_id}" project_id: "{project_id}" } type: "healthcare_consent_store" } severity: "ERROR" timestamp: "TIMESTAMP" ```' operationId: healthcare.projects.locations.datasets.consentStores.queryAccessibleData parameters: - description: Required. Name of the consent store to retrieve User data mappings from. in: path name: consentStore required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/QueryAccessibleDataRequest_2' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Operation' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1beta1/{name}: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' delete: description: Deletes an HL7v2 message. operationId: healthcare.projects.locations.datasets.hl7V2Stores.messages.delete parameters: - description: Required. The resource name of the HL7v2 message to delete. in: path name: name required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/Empty' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects get: description: 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. operationId: healthcare.projects.locations.datasets.operations.get parameters: - description: The name of the operation resource. in: path name: name required: true schema: type: string - description: Specifies which parts of the Message resource to return in the response. When unspecified, equivalent to FULL. in: query name: view schema: enum: - MESSAGE_VIEW_UNSPECIFIED - RAW_ONLY - PARSED_ONLY - FULL - SCHEMATIZED_ONLY - BASIC type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/Operation' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects patch: description: 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. operationId: healthcare.projects.locations.datasets.hl7V2Stores.messages.patch parameters: - 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. in: path name: name required: true schema: type: string - 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 in: query name: updateMask schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Message' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Message' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects put: description: '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 sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. The resource must contain an `id` element having an identical value to the ID in the REST path of the request. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `update`, see [Updating a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#updating_a_fhir_resource).' operationId: healthcare.projects.locations.datasets.fhirStores.fhir.update parameters: - description: Required. The name of the resource to update. in: path name: name required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/HttpBody' responses: '200': content: application/json: schema: $ref: '#/components/schemas/HttpBody' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1beta1/{name}/$consent-enforcement-status: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' get: description: 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. operationId: healthcare.projects.locations.datasets.fhirStores.fhir.Patient-consent-enforcement-status parameters: - 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}` in: path name: name required: true schema: type: string - description: Optional. The maximum number of results on a page. If not specified, 100 is used. May not be larger than 1000. in: query name: _count schema: type: integer - 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. in: query name: _page_token schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/HttpBody' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1beta1/{name}/$everything: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' get: description: '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 `searchset`, containing the results of the operation. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The resources in scope for the response are: * The patient resource itself. * All the resources directly referenced by the patient resource. * Resources directly referencing the patient resource that meet the inclusion criteria. The inclusion criteria are based on the membership rules in the patient compartment definition ([DSTU2](https://hl7.org/fhir/DSTU2/compartment-patient.html), [STU3](http://www.hl7.org/fhir/stu3/compartmentdefinition-patient.html), [R4](https://hl7.org/fhir/R4/compartmentdefinition-patient.html)), which details the eligible resource types and referencing search parameters. For samples that show how to call `Patient-everything`, see [Getting all patient compartment resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#getting_all_patient_compartment_resources).' operationId: healthcare.projects.locations.datasets.fhirStores.fhir.Patient-everything parameters: - description: Required. Name of the `Patient` resource for which the information is required. in: path name: name required: true schema: type: string - description: Maximum number of resources in a page. If not specified, 100 is used. May not be larger than 1000. in: query name: _count schema: type: integer - 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. in: query name: _page_token schema: type: string - 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. in: query name: _since schema: type: string - 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. in: query name: _type schema: type: string - 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. in: query name: end schema: type: string - 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. in: query name: start schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/HttpBody' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1beta1/{name}/$purge: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' delete: description: 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). operationId: healthcare.projects.locations.datasets.fhirStores.fhir.Resource-purge parameters: - description: Required. The name of the resource to purge. in: path name: name required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/Empty' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1beta1/{name}/$translate: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' get: description: 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 representation of a FHIR Parameters resource, which includes the translation result. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. operationId: healthcare.projects.locations.datasets.fhirStores.fhir.ConceptMap-translate parameters: - description: Required. The URL for the concept map to use for the translation. in: path name: name required: true schema: type: string - description: Required. The code to translate. in: query name: code schema: type: string - description: The version of the concept map to use. If unset, the most current version is used. in: query name: conceptMapVersion schema: type: string - description: Required. The system for the code to be translated. in: query name: system schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/HttpBody' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1beta1/{name}/_history: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' get: description: 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 type `history`, containing the version history sorted from most recent to oldest versions. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `history`, see [Listing FHIR resource versions](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#listing_fhir_resource_versions). operationId: healthcare.projects.locations.datasets.fhirStores.fhir.history parameters: - description: Required. The name of the resource to retrieve. in: path name: name required: true schema: type: string - 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`' in: query name: _at schema: type: string - description: The maximum number of search results on a page. If not specified, 100 is used. May not be larger than 1000. in: query name: _count schema: type: integer - 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. in: query name: _page_token schema: type: string - 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. in: query name: _since schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/HttpBody' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1beta1/{name}/fhir/metadata: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' get: description: 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/http.html#capabilities), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#capabilities)), or the [conformance interaction](https://hl7.org/implement/standards/fhir/DSTU2/http.html#conformance) in the DSTU2 case. On success, the response body contains a JSON-encoded representation of a `CapabilityStatement` resource. operationId: healthcare.projects.locations.datasets.fhirStores.fhir.capabilities parameters: - description: Required. Name of the FHIR store to retrieve the capabilities for. in: path name: name required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/HttpBody' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1beta1/{name}/locations: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' get: description: Lists information about the supported locations for this service. operationId: healthcare.projects.locations.list parameters: - description: The resource that owns the locations collection, if applicable. in: path name: name required: true schema: type: string - 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). in: query name: filter schema: type: string - description: The maximum number of results to return. If not set, the service selects a default. in: query name: pageSize schema: type: integer - description: A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. in: query name: pageToken schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListLocationsResponse' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1beta1/{name}/operations: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' get: description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. operationId: healthcare.projects.locations.datasets.operations.list parameters: - description: The name of the operation's parent resource. in: path name: name required: true schema: type: string - description: The standard list filter. in: query name: filter schema: type: string - description: The standard list page size. in: query name: pageSize schema: type: integer - description: The standard list page token. in: query name: pageToken schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListOperationsResponse' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1beta1/{name}:activate: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' post: description: 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. operationId: healthcare.projects.locations.datasets.consentStores.consents.activate parameters: - 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. in: path name: name required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ActivateConsentRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Consent_2' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1beta1/{name}:applyAdminConsents: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' post: description: 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 can be used to track the progress of the resources that were reindexed, by calling GetOperation. Upon completion, the ApplyAdminConsentsResponse additionally contains the number of resources that were reindexed. If at least one Consent resource contains an error or fails be be enforced for any reason, the method returns an error instead of an Operation. No resources will be reindexed and the `consent_config.enforced_admin_consents` field will be unchanged. To enforce a consent check for data access, `consent_config.access_enforced` must be set to true for the FhirStore. operationId: healthcare.projects.locations.datasets.fhirStores.applyAdminConsents parameters: - 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}`. in: path name: name required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ApplyAdminConsentsRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Operation' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1beta1/{name}:applyConsents: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' post: description: 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 calling GetOperation. Upon completion, the ApplyConsentsResponse additionally contains the number of resources that was reindexed. Errors are logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). To enforce consent check for data access, `consent_config.access_enforced` must be set to true for the FhirStore. operationId: healthcare.projects.locations.datasets.fhirStores.applyConsents parameters: - 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}`. in: path name: name required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ApplyConsentsRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Operation' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1beta1/{name}:archive: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' post: description: Archives the specified User data mapping. operationId: healthcare.projects.locations.datasets.consentStores.userDataMappings.archive parameters: - description: Required. The resource name of the User data mapping to archive. in: path name: name required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ArchiveUserDataMappingRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/ArchiveUserDataMappingResponse' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1beta1/{name}:cancel: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' post: description: Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. operationId: healthcare.projects.locations.datasets.operations.cancel parameters: - description: The name of the operation resource to be cancelled. in: path name: name required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CancelOperationRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Empty' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1beta1/{name}:configureSearch: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' post: description: 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. operationId: healthcare.projects.locations.datasets.fhirStores.configureSearch parameters: - 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}`. in: path name: name required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ConfigureSearchRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Operation' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1beta1/{name}:deleteRevision: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' delete: description: Deletes the specified revision of a Consent. An INVALID_ARGUMENT error occurs if the specified revision is the latest revision. operationId: healthcare.projects.locations.datasets.consentStores.consents.deleteRevision parameters: - 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. in: path name: name required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/Empty' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1beta1/{name}:evaluate: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' post: description: 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)). operationId: healthcare.projects.locations.datasets.annotationStores.evaluate parameters: - 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}`. in: path name: name required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/EvaluateAnnotationStoreRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Operation' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1beta1/{name}:explainDataAccess: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' get: description: Explains all the permitted/denied actor, purpose and environment for a given resource. operationId: healthcare.projects.locations.datasets.fhirStores.explainDataAccess parameters: - 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}`. in: path name: name required: true schema: type: string - description: Required. The ID (`{resourceType}/{id}`) of the resource to explain data access on. in: query name: resourceId schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExplainDataAccessResponse' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1beta1/{name}:export: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' post: description: Exports the messages to a destination. To filter messages to be exported, define a filter using the start and end time, relative to the message generation time (MSH.7). This API returns an Operation that can be used to track the status of the job by calling GetOperation. Immediate fatal errors appear in the error field. Otherwise, when the operation finishes, a detailed response of type ExportMessagesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata. operationId: healthcare.projects.locations.datasets.hl7V2Stores.export parameters: - 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}` in: path name: name required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ExportMessagesRequest_2' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Operation' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1beta1/{name}:getDICOMStoreMetrics: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' get: description: Gets metrics associated with the DICOM store. operationId: healthcare.projects.locations.datasets.dicomStores.getDICOMStoreMetrics parameters: - description: Required. The resource name of the DICOM store to get metrics for. in: path name: name required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/DicomStoreMetrics' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1beta1/{name}:getFHIRStoreMetrics: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' get: description: Gets metrics associated with the FHIR store. operationId: healthcare.projects.locations.datasets.fhirStores.getFHIRStoreMetrics parameters: - description: Required. The resource name of the FHIR store to get metrics for. in: path name: name required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/FhirStoreMetrics' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1beta1/{name}:getHL7v2StoreMetrics: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' get: description: Gets metrics associated with the HL7v2 store. operationId: healthcare.projects.locations.datasets.hl7V2Stores.getHL7v2StoreMetrics parameters: - 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}`. in: path name: name required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/Hl7V2StoreMetrics' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1beta1/{name}:import: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' post: description: Import messages to the HL7v2 store by loading data from the specified sources. This method is optimized to load large quantities of data using import semantics that ignore some HL7v2 store configuration options and are not suitable for all use cases. It is primarily intended to load data into an empty HL7v2 store that is not being used by other clients. An existing message will be overwritten if a duplicate message is imported. A duplicate message is a message with the same raw bytes as a message that already exists in this HL7v2 store. When a message is overwritten, its labels will also be overwritten. The import operation is idempotent unless the input data contains multiple valid messages with the same raw bytes but different labels. In that case, after the import completes, the store contains exactly one message with those raw bytes but there is no ordering guarantee on which version of the labels it has. The operation result counters do not count duplicated raw bytes as an error and count one success for each message in the input, which might result in a success count larger than the number of messages in the HL7v2 store. If some messages fail to import, for example due to parsing errors, successfully imported messages are not rolled back. This method returns an Operation that can be used to track the status of the import by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). Otherwise, when the operation finishes, a response of type ImportMessagesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata. operationId: healthcare.projects.locations.datasets.hl7V2Stores.import parameters: - 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}` in: path name: name required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ImportMessagesRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Operation' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1beta1/{name}:listRevisions: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' get: description: Lists the revisions of the specified Consent in reverse chronological order. operationId: healthcare.projects.locations.datasets.consentStores.consents.listRevisions parameters: - description: Required. The resource name of the Consent to retrieve revisions for. in: path name: name required: true schema: type: string - 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\")`.' in: query name: filter schema: type: string - 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. in: query name: pageSize schema: type: integer - description: Optional. Token to retrieve the next page of results or empty if there are no more results in the list. in: query name: pageToken schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListConsentRevisionsResponse' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1beta1/{name}:reject: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' post: description: 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. operationId: healthcare.projects.locations.datasets.consentStores.consents.reject parameters: - 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. in: path name: name required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/RejectConsentRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Consent_2' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1beta1/{name}:revoke: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' post: description: 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. operationId: healthcare.projects.locations.datasets.consentStores.consents.revoke parameters: - 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. in: path name: name required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/RevokeConsentRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Consent_2' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1beta1/{name}:rollback: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' post: description: Rolls back resources from the FHIR store to the specified time. This method returns an Operation that can be used to track the status of the rollback by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). Otherwise, when the operation finishes, a detailed response of type RollbackFhirResourcesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata. operationId: healthcare.projects.locations.datasets.fhirStores.rollback parameters: - 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}". in: path name: name required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/RollbackFhirResourcesRequest_2' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Operation' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1beta1/{nlpService}:analyzeEntities: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' post: description: 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. operationId: healthcare.projects.locations.services.nlp.analyzeEntities parameters: - description: 'The resource name of the service of the form: "projects/{project_id}/locations/{location_id}/services/nlp".' in: path name: nlpService required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AnalyzeEntitiesRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/AnalyzeEntitiesResponse' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1beta1/{parent}/annotationStores: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' get: description: Lists the Annotation stores in the given dataset for a source store. operationId: healthcare.projects.locations.datasets.annotationStores.list parameters: - description: Required. Name of the dataset. in: path name: parent required: true schema: type: string - 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`.' in: query name: filter schema: type: string - 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. in: query name: pageSize schema: type: integer - description: The next_page_token value returned from the previous List request, if any. in: query name: pageToken schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListAnnotationStoresResponse' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects post: description: Creates a new Annotation store within the parent dataset. operationId: healthcare.projects.locations.datasets.annotationStores.create parameters: - description: Required. The name of the dataset this Annotation store belongs to. in: path name: parent required: true schema: type: string - 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}`.' in: query name: annotationStoreId schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AnnotationStore' responses: '200': content: application/json: schema: $ref: '#/components/schemas/AnnotationStore' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1beta1/{parent}/annotations: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' get: description: Lists the Annotations in the given Annotation store for a source resource. operationId: healthcare.projects.locations.datasets.annotationStores.annotations.list parameters: - description: Required. Name of the Annotation store to retrieve Annotations from. in: path name: parent required: true schema: type: string - 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`.' in: query name: filter schema: type: string - 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. in: query name: pageSize schema: type: integer - description: The next_page_token value returned from the previous List request, if any. in: query name: pageToken schema: type: string - description: Controls which fields are populated in the response. in: query name: view schema: enum: - ANNOTATION_VIEW_UNSPECIFIED - ANNOTATION_VIEW_BASIC - ANNOTATION_VIEW_FULL type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListAnnotationsResponse' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects post: description: 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. operationId: healthcare.projects.locations.datasets.annotationStores.annotations.create parameters: - description: Required. The name of the Annotation store this annotation belongs to. For example, `projects/my-project/locations/us-central1/datasets/mydataset/annotationStores/myannotationstore`. in: path name: parent required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Annotation' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Annotation' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1beta1/{parent}/attributeDefinitions: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' get: description: Lists the Attribute definitions in the specified consent store. operationId: healthcare.projects.locations.datasets.consentStores.attributeDefinitions.list parameters: - description: Required. Name of the consent store to retrieve Attribute definitions from. in: path name: parent required: true schema: type: string - 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\"`.' in: query name: filter schema: type: string - 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. in: query name: pageSize schema: type: integer - description: Optional. Token to retrieve the next page of results or empty to get the first page. in: query name: pageToken schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListAttributeDefinitionsResponse' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects post: description: Creates a new Attribute definition in the parent consent store. operationId: healthcare.projects.locations.datasets.consentStores.attributeDefinitions.create parameters: - description: Required. The name of the consent store that this Attribute definition belongs to. in: path name: parent required: true schema: type: string - 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.' in: query name: attributeDefinitionId schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AttributeDefinition' responses: '200': content: application/json: schema: $ref: '#/components/schemas/AttributeDefinition' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1beta1/{parent}/consentArtifacts: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' get: description: Lists the Consent artifacts in the specified consent store. operationId: healthcare.projects.locations.datasets.consentStores.consentArtifacts.list parameters: - description: Required. Name of the consent store to retrieve consent artifacts from. in: path name: parent required: true schema: type: string - 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\")`.' in: query name: filter schema: type: string - 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. in: query name: pageSize schema: type: integer - description: Optional. The next_page_token value returned from the previous List request, if any. in: query name: pageToken schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListConsentArtifactsResponse' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects post: description: Creates a new Consent artifact in the parent consent store. operationId: healthcare.projects.locations.datasets.consentStores.consentArtifacts.create parameters: - description: Required. The name of the consent store this Consent artifact belongs to. in: path name: parent required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ConsentArtifact' responses: '200': content: application/json: schema: $ref: '#/components/schemas/ConsentArtifact' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1beta1/{parent}/consentStores: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' get: description: Lists the consent stores in the specified dataset. operationId: healthcare.projects.locations.datasets.consentStores.list parameters: - description: Required. Name of the dataset. in: path name: parent required: true schema: type: string - 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`.' in: query name: filter schema: type: string - 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. in: query name: pageSize schema: type: integer - description: Optional. Token to retrieve the next page of results, or empty to get the first page. in: query name: pageToken schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListConsentStoresResponse' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects post: description: 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. operationId: healthcare.projects.locations.datasets.consentStores.create parameters: - description: Required. The name of the dataset this consent store belongs to. in: path name: parent required: true schema: type: string - 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.' in: query name: consentStoreId schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ConsentStore_2' responses: '200': content: application/json: schema: $ref: '#/components/schemas/ConsentStore_2' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1beta1/{parent}/consents: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' get: description: Lists the Consent in the given consent store, returning each Consent's latest revision. operationId: healthcare.projects.locations.datasets.consentStores.consents.list parameters: - description: Required. Name of the consent store to retrieve Consents from. in: path name: parent required: true schema: type: string - 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\")`.' in: query name: filter schema: type: string - 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. in: query name: pageSize schema: type: integer - description: Optional. The next_page_token value returned from the previous List request, if any. in: query name: pageToken schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListConsentsResponse' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects post: description: Creates a new Consent in the parent consent store. operationId: healthcare.projects.locations.datasets.consentStores.consents.create parameters: - description: Required. Name of the consent store. in: path name: parent required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Consent_2' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Consent_2' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1beta1/{parent}/datasets: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' get: description: Lists the health datasets in the current project. operationId: healthcare.projects.locations.datasets.list parameters: - description: Required. The name of the project whose datasets should be listed. For example, `projects/{project_id}/locations/{location_id}`. in: path name: parent required: true schema: type: string - description: The maximum number of items to return. If not specified, 100 is used. May not be larger than 1000. in: query name: pageSize schema: type: integer - description: The next_page_token value returned from a previous List request, if any. in: query name: pageToken schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListDatasetsResponse' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects post: description: 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. operationId: healthcare.projects.locations.datasets.create parameters: - description: Required. The name of the project where the server creates the dataset. For example, `projects/{project_id}/locations/{location_id}`. in: path name: parent required: true schema: type: string - description: 'Required. The ID of the dataset that is being created. The string must match the following regex: `[\p{L}\p{N}_\-\.]{1,256}`.' in: query name: datasetId schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Dataset' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Operation' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1beta1/{parent}/dicomStores: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' get: description: Lists the DICOM stores in the given dataset. operationId: healthcare.projects.locations.datasets.dicomStores.list parameters: - description: Required. Name of the dataset. in: path name: parent required: true schema: type: string - 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`.' in: query name: filter schema: type: string - 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. in: query name: pageSize schema: type: integer - description: The next_page_token value returned from the previous List request, if any. in: query name: pageToken schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListDicomStoresResponse' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects post: description: Creates a new DICOM store within the parent dataset. operationId: healthcare.projects.locations.datasets.dicomStores.create parameters: - description: Required. The name of the dataset this DICOM store belongs to. in: path name: parent required: true schema: type: string - description: Required. The ID of the DICOM store that is being created. Any string value up to 256 characters in length. in: query name: dicomStoreId schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/DicomStore_2' responses: '200': content: application/json: schema: $ref: '#/components/schemas/DicomStore_2' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1beta1/{parent}/dicomWeb/{dicomWebPath}: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' delete: description: 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). operationId: healthcare.projects.locations.datasets.dicomStores.studies.series.instances.delete parameters: - 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}`. in: path name: parent required: true schema: type: string - description: Required. The path of the DeleteInstance request. For example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}`. in: path name: dicomWebPath required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/Empty' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects get: description: RetrieveRenderedFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers in an acceptable Rendered Media Type. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedFrames, see [Rendered resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedFrames, see [Retrieve consumer image formats](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-consumer). operationId: healthcare.projects.locations.datasets.dicomStores.studies.series.instances.frames.retrieveRendered parameters: - 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}`. in: path name: parent required: true schema: type: string - description: Required. The path of the RetrieveRenderedFrames DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}/frames/{frame_list}/rendered`. in: path name: dicomWebPath required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/HttpBody' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects post: description: StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). For details on the implementation of StoreInstances, see [Store transaction](https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see [Store DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#store-dicom). operationId: healthcare.projects.locations.datasets.dicomStores.studies.storeInstances parameters: - 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}`. in: path name: parent required: true schema: type: string - description: Required. The path of the StoreInstances DICOMweb request. For example, `studies/[{study_uid}]`. Note that the `study_uid` is optional. in: path name: dicomWebPath required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/HttpBody' responses: '200': content: application/json: schema: $ref: '#/components/schemas/HttpBody' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1beta1/{parent}/fhir: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' post: description: '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`, processing `batch` and `transaction` bundles according to the batch processing rules ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.1), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.1), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#brules)) and transaction processing rules ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.2), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.2), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#trules)). The request body must contain a JSON-encoded FHIR `Bundle` resource, and the request headers must contain `Content-Type: application/fhir+json`. For a batch bundle or a successful transaction, the response body contains a JSON-encoded representation of a `Bundle` resource of type `batch-response` or `transaction-response` containing one entry for each entry in the request, with the outcome of processing the entry. In the case of an error for a `transaction` or `history` bundle, the response body contains a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. This method checks permissions for each request in the bundle. The `executeBundle` permission is required to call this method, but you must also grant sufficient permissions to execute the individual requests in the bundle. For example, if the bundle contains a request to create a FHIR resource, the caller must also have been granted the `healthcare.fhirResources.create` permission. `history` bundles also check the `import` permission. You can use audit logs to view the permissions for `executeBundle` and each request in the bundle. For more information, see [Viewing Cloud Audit logs](https://cloud.google.com/healthcare-api/docs/how-tos/audit-logging). For samples that show how to call `executeBundle`, see [Managing FHIR resources using FHIR bundles](https://cloud.google.com/healthcare/docs/how-tos/fhir-bundles).' operationId: healthcare.projects.locations.datasets.fhirStores.fhir.executeBundle parameters: - description: Required. Name of the FHIR store in which this bundle will be executed. in: path name: parent required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/HttpBody' responses: '200': content: application/json: schema: $ref: '#/components/schemas/HttpBody' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1beta1/{parent}/fhir/$references: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' get: description: 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 Google Cloud error might be returned instead. operationId: healthcare.projects.locations.datasets.fhirStores.fhir.Resource-incoming-references parameters: - description: Required. The name of the FHIR store that holds the target resource. in: path name: parent required: true schema: type: string - description: Maximum number of resources in a page. If not specified, 100 is used. May not be larger than 1000. in: query name: _count schema: type: integer - 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. in: query name: _page_token schema: type: string - 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). in: query name: _summary schema: type: string - 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. in: query name: _type schema: type: string - 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. in: query name: target schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/HttpBody' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1beta1/{parent}/fhir/ConceptMap/$translate: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' get: description: 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 result. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. operationId: healthcare.projects.locations.datasets.fhirStores.fhir.ConceptMap-search-translate parameters: - description: Required. The name for the FHIR store containing the concept map(s) to use for the translation. in: path name: parent required: true schema: type: string - description: Required. The code to translate. in: query name: code schema: type: string - description: The version of the concept map to use. If unset, the most current version is used. in: query name: conceptMapVersion schema: type: string - description: The source value set of the concept map to be used. If unset, target is used to search for concept maps. in: query name: source schema: type: string - description: Required. The system for the code to be translated. in: query name: system schema: type: string - description: The target value set of the concept map to be used. If unset, source is used to search for concept maps. in: query name: target schema: type: string - description: The canonical url of the concept map to use. If unset, the source and target is used to search for concept maps. in: query name: url schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/HttpBody' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1beta1/{parent}/fhir/Observation/$lastn: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' get: description: '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 the same way it supports STU3. Search terms are provided as query parameters following the same pattern as the search method. The following search parameters must be provided: - `subject` or `patient` to specify a subject for the Observation. - `code`, `category` or any of the composite parameters that include `code`. Any other valid Observation search parameters can also be provided. This operation accepts an additional query parameter `max`, which specifies N, the maximum number of Observations to return from each group, with a default of 1. Searches with over 1000 results are rejected. Results are counted before grouping and limiting the results with `max`. To stay within the limit, constrain these searches using Observation search parameters such as `_lastUpdated` or `date`. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the operation. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead.' operationId: healthcare.projects.locations.datasets.fhirStores.fhir.Observation-lastn parameters: - description: Required. Name of the FHIR store to retrieve resources from. in: path name: parent required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/HttpBody' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1beta1/{parent}/fhir/_search: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' post: description: '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), [STU3](https://hl7.org/implement/standards/fhir/STU3/search.html), [R4](https://hl7.org/implement/standards/fhir/R4/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server''s capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](https://hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html), [R4](https://hl7.org/implement/standards/fhir/R4/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource''s definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned `Bundle` contains a link of `relation` "next", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any of the following search result parameters can be used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn''t optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the default sorting order. Note: The special synchronous identifier index are currently disabled for DocumentReference and DocumentManifest searches. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).' operationId: healthcare.projects.locations.datasets.fhirStores.fhir.search parameters: - description: Required. Name of the FHIR store to retrieve resources from. in: path name: parent required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SearchResourcesRequest_2' responses: '200': content: application/json: schema: $ref: '#/components/schemas/HttpBody' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1beta1/{parent}/fhir/{resourceType}/_search: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' post: description: '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), [STU3](https://hl7.org/implement/standards/fhir/STU3/search.html), [R4](https://hl7.org/implement/standards/fhir/R4/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server''s capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](https://hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html), [R4](https://hl7.org/implement/standards/fhir/R4/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource''s definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned `Bundle` contains a link of `relation` "next", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any of the following search result parameters can be used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn''t optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the default sorting order. Note: The special synchronous identifier index are currently disabled for DocumentReference and DocumentManifest searches. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).' operationId: healthcare.projects.locations.datasets.fhirStores.fhir.search-type parameters: - description: Required. Name of the FHIR store to retrieve resources from. in: path name: parent required: true schema: type: string - 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)). in: path name: resourceType required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SearchResourcesRequest_2' responses: '200': content: application/json: schema: $ref: '#/components/schemas/HttpBody' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1beta1/{parent}/fhir/{type}: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' delete: description: '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. Not all FHIR resources that match the search query might be deleted because, by default, a maximum of 100 FHIR resources can be deleted. The number of FHIR resources that can be deleted depends on the page size of the returned resources, which you can control using the `_count` query parameter. Even when using `_count`, you can delete a maximum 1,000 FHIR resources per each call of `conditionalDelete`. Note: Unless resource versioning is disabled by setting the disable_resource_versioning flag on the FHIR store, the deleted resources are moved to a history repository that can still be retrieved through vread and related methods, unless they are removed by the purge method. This method requires the`healthcare.fhirStores.searchResources` and `healthcare.fhirResources.delete` permissions on the parent FHIR store. For samples that show how to call `conditionalDelete`, see [Conditionally deleting a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#conditionally_deleting_a_fhir_resource).' operationId: healthcare.projects.locations.datasets.fhirStores.fhir.conditionalDelete parameters: - description: Required. The name of the FHIR store this resource belongs to. in: path name: parent required: true schema: type: string - 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)). in: path name: type required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/Empty' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects patch: description: '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 supports STU3. Search terms are provided as query parameters following the same pattern as the search method. If the search criteria identify more than one match, the request returns a `412 Precondition Failed` error. The request body must contain a JSON Patch document, and the request headers must contain `Content-Type: application/json-patch+json`. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. This method requires the`healthcare.fhirStores.searchResources` permission on the parent FHIR store and the `healthcare.fhirResources.patch` permission on the requested FHIR store resource. For samples that show how to call `conditionalPatch`, see [Conditionally patching a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#conditionally_patching_a_fhir_resource).' operationId: healthcare.projects.locations.datasets.fhirStores.fhir.conditionalPatch parameters: - description: Required. The name of the FHIR store this resource belongs to. in: path name: parent required: true schema: type: string - 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)). in: path name: type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/HttpBody' responses: '200': content: application/json: schema: $ref: '#/components/schemas/HttpBody' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects post: description: '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](https://hl7.org/implement/standards/fhir/STU3/http.html#ccreate), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#ccreate)), specified by supplying an `If-None-Exist` header containing a FHIR search query. If no resources match this search query, the server processes the create operation as normal. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. On success, the response body contains a JSON-encoded representation of the resource as it was created on the server, including the server-assigned resource ID and version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `create`, see [Creating a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#creating_a_fhir_resource).' operationId: healthcare.projects.locations.datasets.fhirStores.fhir.create parameters: - description: Required. The name of the FHIR store this resource belongs to. in: path name: parent required: true schema: type: string - 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. in: path name: type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/HttpBody' responses: '200': content: application/json: schema: $ref: '#/components/schemas/HttpBody' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects put: description: '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 the search method. If the search criteria identify more than one match, the request returns a `412 Precondition Failed` error. If the search criteria identify zero matches, and the supplied resource body contains an `id`, and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. If the search criteria identify zero matches, and the supplied resource body does not contain an `id`, the resource is created with a server-assigned ID as per the create method. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. This method requires the`healthcare.fhirStores.searchResources` and `healthcare.fhirResources.update` permissions on the parent FHIR store. For samples that show how to call `conditionalUpdate`, see [Conditionally updating a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#conditionally_updating_a_fhir_resource).' operationId: healthcare.projects.locations.datasets.fhirStores.fhir.conditionalUpdate parameters: - description: Required. The name of the FHIR store this resource belongs to. in: path name: parent required: true schema: type: string - 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. in: path name: type required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/HttpBody' responses: '200': content: application/json: schema: $ref: '#/components/schemas/HttpBody' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1beta1/{parent}/fhir/{type}/$validate: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' post: description: 'Validates an input FHIR resource''s conformance to its profiles and the profiles configured on the FHIR store. Implements the FHIR extended operation $validate ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resource-operations.html#validate), [STU3](http://hl7.org/implement/standards/fhir/STU3/resource-operations.html#validate), or [R4](http://hl7.org/implement/standards/fhir/R4/resource-operation-validate.html)). The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. The `Parameters` input syntax is not supported. The `profile` query parameter can be used to request that the resource only be validated against a specific profile. If a profile with the given URL cannot be found in the FHIR store then an error is returned. Errors generated by validation contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead.' operationId: healthcare.projects.locations.datasets.fhirStores.fhir.Resource-validate parameters: - description: Required. The name of the FHIR store that holds the profiles being used for validation. in: path name: parent required: true schema: type: string - 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. in: path name: type required: true schema: type: string - 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. in: query name: profile schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/HttpBody' responses: '200': content: application/json: schema: $ref: '#/components/schemas/HttpBody' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1beta1/{parent}/fhirStores: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' get: description: Lists the FHIR stores in the given dataset. operationId: healthcare.projects.locations.datasets.fhirStores.list parameters: - description: Required. Name of the dataset. in: path name: parent required: true schema: type: string - 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`.' in: query name: filter schema: type: string - 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. in: query name: pageSize schema: type: integer - description: The next_page_token value returned from the previous List request, if any. in: query name: pageToken schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListFhirStoresResponse' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects post: description: Creates a new FHIR store within the parent dataset. operationId: healthcare.projects.locations.datasets.fhirStores.create parameters: - description: Required. The name of the dataset this FHIR store belongs to. in: path name: parent required: true schema: type: string - 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}`.' in: query name: fhirStoreId schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FhirStore_2' responses: '200': content: application/json: schema: $ref: '#/components/schemas/FhirStore_2' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1beta1/{parent}/hl7V2Stores: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' get: description: Lists the HL7v2 stores in the given dataset. operationId: healthcare.projects.locations.datasets.hl7V2Stores.list parameters: - description: Required. Name of the dataset. in: path name: parent required: true schema: type: string - 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`.' in: query name: filter schema: type: string - 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. in: query name: pageSize schema: type: integer - description: The next_page_token value returned from the previous List request, if any. in: query name: pageToken schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListHl7V2StoresResponse' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects post: description: Creates a new HL7v2 store within the parent dataset. operationId: healthcare.projects.locations.datasets.hl7V2Stores.create parameters: - description: Required. The name of the dataset this HL7v2 store belongs to. in: path name: parent required: true schema: type: string - 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}`.' in: query name: hl7V2StoreId schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Hl7V2Store_2' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Hl7V2Store_2' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1beta1/{parent}/messages: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' get: description: '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.' operationId: healthcare.projects.locations.datasets.hl7V2Stores.messages.list parameters: - description: Required. Name of the HL7v2 store to retrieve messages from. in: path name: parent required: true schema: type: string - 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":*`.' in: query name: filter schema: type: string - 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`' in: query name: orderBy schema: type: string - 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. in: query name: pageSize schema: type: integer - description: The next_page_token value returned from the previous List request, if any. in: query name: pageToken schema: type: string - 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. in: query name: view schema: enum: - MESSAGE_VIEW_UNSPECIFIED - RAW_ONLY - PARSED_ONLY - FULL - SCHEMATIZED_ONLY - BASIC type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListMessagesResponse' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects post: description: 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. operationId: healthcare.projects.locations.datasets.hl7V2Stores.messages.create parameters: - description: Required. The name of the HL7v2 store this message belongs to. in: path name: parent required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateMessageRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Message' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1beta1/{parent}/messages:batchGet: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' get: description: Gets multiple messages in the given HL7v2 store. operationId: healthcare.projects.locations.datasets.hl7V2Stores.messages.batchGet parameters: - 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}`.' in: path name: parent required: true schema: type: string - 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.' explode: true in: query name: ids schema: items: type: string type: array style: form - description: Specifies the parts of the Messages resource to return in the response. When unspecified, equivalent to BASIC. in: query name: view schema: enum: - MESSAGE_VIEW_UNSPECIFIED - RAW_ONLY - PARSED_ONLY - FULL - SCHEMATIZED_ONLY - BASIC type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/BatchGetMessagesResponse' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1beta1/{parent}/messages:ingest: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' post: description: Parses and stores an HL7v2 message. This method triggers an asynchronous notification to any Pub/Sub topic configured in Hl7V2Store.Hl7V2NotificationConfig, if the filtering matches the message. If an MLLP adapter is configured to listen to a Pub/Sub topic, the adapter transmits the message when a notification is received. If the method is successful, it generates a response containing an HL7v2 acknowledgment (`ACK`) message. If the method encounters an error, it returns a negative acknowledgment (`NACK`) message. This behavior is suitable for replying to HL7v2 interface systems that expect these acknowledgments. operationId: healthcare.projects.locations.datasets.hl7V2Stores.messages.ingest parameters: - description: Required. The name of the HL7v2 store this message belongs to. in: path name: parent required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/IngestMessageRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/IngestMessageResponse' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1beta1/{parent}/userDataMappings: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' get: description: Lists the User data mappings in the specified consent store. operationId: healthcare.projects.locations.datasets.consentStores.userDataMappings.list parameters: - description: Required. Name of the consent store to retrieve User data mappings from. in: path name: parent required: true schema: type: string - 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' in: query name: filter schema: type: string - 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. in: query name: pageSize schema: type: integer - description: Optional. Token to retrieve the next page of results, or empty to get the first page. in: query name: pageToken schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListUserDataMappingsResponse' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects post: description: Creates a new User data mapping in the parent consent store. operationId: healthcare.projects.locations.datasets.consentStores.userDataMappings.create parameters: - description: Required. Name of the consent store. in: path name: parent required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UserDataMapping' responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserDataMapping' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1beta1/{resource}:getIamPolicy: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' get: description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. operationId: healthcare.projects.locations.datasets.hl7V2Stores.getIamPolicy parameters: - 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.' in: path name: resource required: true schema: type: string - 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). in: query name: options.requestedPolicyVersion schema: type: integer responses: '200': content: application/json: schema: $ref: '#/components/schemas/Policy' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1beta1/{resource}:getStorageInfo: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' get: description: GetStorageInfo returns the storage info of the specified resource. operationId: healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.instances.getStorageInfo parameters: - 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}`)' in: path name: resource required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/StorageInfo' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1beta1/{resource}:setBlobStorageSettings: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' post: description: SetBlobStorageSettings sets the blob storage settings of the specified resources. operationId: healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.setBlobStorageSettings parameters: - 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}`. in: path name: resource required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SetBlobStorageSettingsRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Operation' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1beta1/{resource}:setIamPolicy: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' post: description: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. operationId: healthcare.projects.locations.datasets.hl7V2Stores.setIamPolicy parameters: - 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.' in: path name: resource required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SetIamPolicyRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Policy' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1beta1/{resource}:testIamPermissions: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' post: description: '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.' operationId: healthcare.projects.locations.datasets.hl7V2Stores.testIamPermissions parameters: - 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.' in: path name: resource required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/TestIamPermissionsRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/TestIamPermissionsResponse' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1beta1/{series}:getSeriesMetrics: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' get: description: GetSeriesMetrics returns metrics for a series. operationId: healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.getSeriesMetrics parameters: - 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}`. in: path name: series required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/SeriesMetrics' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1beta1/{sourceDataset}:deidentify: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' post: description: 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 [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging). operationId: healthcare.projects.locations.datasets.deidentify parameters: - description: Required. Source dataset resource name. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`. in: path name: sourceDataset required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/DeidentifyDatasetRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Operation' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1beta1/{sourceStore}:deidentify: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' post: description: 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). operationId: healthcare.projects.locations.datasets.fhirStores.deidentify parameters: - description: Required. Source FHIR store resource name. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. in: path name: sourceStore required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/DeidentifyFhirStoreRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Operation' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects /v1beta1/{study}:getStudyMetrics: parameters: - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' get: description: GetStudyMetrics returns metrics for a study. operationId: healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.getStudyMetrics parameters: - 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}`. in: path name: study required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/StudyMetrics' description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: - https://www.googleapis.com/auth/cloud-healthcare - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform tags: - projects components: schemas: Dataset: description: A message representing a health dataset. A health dataset represents a collection of healthcare data pertaining to one or more patients. This may include multiple modalities of healthcare data, such as electronic medical records or medical imaging data. properties: name: description: Identifier. Resource name of the dataset, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`. type: string timeZone: description: The default timezone used by this dataset. Must be a either a valid IANA time zone name such as "America/New_York" or empty, which defaults to UTC. This is used for parsing times in resources, such as HL7 messages, where no explicit timezone is specified. type: string type: object GcsDestination: description: The Cloud Storage output destination. The Cloud Healthcare Service Agent requires the `roles/storage.objectAdmin` Cloud IAM roles on the Cloud Storage location. properties: contentStructure: description: The format of the exported HL7v2 message files. enum: - CONTENT_STRUCTURE_UNSPECIFIED - MESSAGE_JSON type: string messageView: description: Specifies the parts of the Message resource to include in the export. If not specified, FULL is used. enum: - MESSAGE_VIEW_UNSPECIFIED - RAW_ONLY - PARSED_ONLY - FULL - SCHEMATIZED_ONLY - BASIC type: string uriPrefix: description: URI of an existing Cloud Storage directory where the server writes result files, in the format `gs://{bucket-id}/{path/to/destination/dir}`. If there is no trailing slash, the service appends one when composing the object path. type: string type: object Binding: description: Associates `members`, or principals, with a `role`. properties: condition: $ref: '#/components/schemas/Expr' description: The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). members: description: 'Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.' items: type: string type: array role: description: Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles). type: string type: object ReplaceWithInfoTypeConfig: description: When using the INSPECT_AND_TRANSFORM action, each match is replaced with the name of the info_type. For example, "My name is Jane" becomes "My name is [PERSON_NAME]." The TRANSFORM action is equivalent to redacting. properties: {} type: object Consent_2: description: Represents a user's consent. properties: consentArtifact: description: Required. The resource name of the Consent artifact that contains proof of the end user's consent, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consentArtifacts/{consent_artifact_id}`. type: string expireTime: description: Timestamp in UTC of when this Consent is considered expired. format: google-datetime type: string metadata: additionalProperties: type: string description: 'Optional. User-supplied key-value pairs used to organize Consent resources. Metadata keys must: - be between 1 and 63 characters long - have a UTF-8 encoding of maximum 128 bytes - begin with a letter - consist of up to 63 characters including lowercase letters, numeric characters, underscores, and dashes Metadata values must be: - be between 1 and 63 characters long - have a UTF-8 encoding of maximum 128 bytes - consist of up to 63 characters including lowercase letters, numeric characters, underscores, and dashes No more than 64 metadata entries can be associated with a given consent.' type: object name: description: Identifier. Resource name of the Consent, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}`. Cannot be changed after creation. type: string policies: description: Optional. Represents a user's consent in terms of the resources that can be accessed and under what conditions. items: $ref: '#/components/schemas/GoogleCloudHealthcareV1beta1ConsentPolicy' type: array revisionCreateTime: description: Output only. The timestamp that the revision was created. format: google-datetime readOnly: true type: string revisionId: description: Output only. The revision ID of the Consent. The format is an 8-character hexadecimal string. Refer to a specific revision of a Consent by appending `@{revision_id}` to the Consent's resource name. readOnly: true type: string state: description: Required. Indicates the current state of this Consent. enum: - STATE_UNSPECIFIED - ACTIVE - ARCHIVED - REVOKED - DRAFT - REJECTED type: string ttl: description: Input only. The time to live for this Consent from when it is created. format: google-duration type: string userId: description: Required. User's UUID provided by the client. type: string type: object ListUserDataMappingsResponse: properties: nextPageToken: description: Token to retrieve the next page of results, or empty if there are no more results in the list. type: string userDataMappings: description: The returned User data mappings. The maximum number of User data mappings returned is determined by the value of page_size in the ListUserDataMappingsRequest. items: $ref: '#/components/schemas/UserDataMapping' type: array type: object Consent: description: Represents a user's consent. properties: consentArtifact: description: Required. The resource name of the Consent artifact that contains proof of the end user's consent, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consentArtifacts/{consent_artifact_id}`. type: string expireTime: description: Timestamp in UTC of when this Consent is considered expired. format: google-datetime type: string metadata: additionalProperties: type: string description: 'Optional. User-supplied key-value pairs used to organize Consent resources. Metadata keys must: - be between 1 and 63 characters long - have a UTF-8 encoding of maximum 128 bytes - begin with a letter - consist of up to 63 characters including lowercase letters, numeric characters, underscores, and dashes Metadata values must be: - be between 1 and 63 characters long - have a UTF-8 encoding of maximum 128 bytes - consist of up to 63 characters including lowercase letters, numeric characters, underscores, and dashes No more than 64 metadata entries can be associated with a given consent.' type: object name: description: Identifier. Resource name of the Consent, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}`. Cannot be changed after creation. type: string policies: description: Optional. Represents a user's consent in terms of the resources that can be accessed and under what conditions. items: $ref: '#/components/schemas/GoogleCloudHealthcareV1ConsentPolicy' type: array revisionCreateTime: description: Output only. The timestamp that the revision was created. format: google-datetime readOnly: true type: string revisionId: description: Output only. The revision ID of the Consent. The format is an 8-character hexadecimal string. Refer to a specific revision of a Consent by appending `@{revision_id}` to the Consent's resource name. readOnly: true type: string state: description: Required. Indicates the current state of this Consent. enum: - STATE_UNSPECIFIED - ACTIVE - ARCHIVED - REVOKED - DRAFT - REJECTED type: string ttl: description: Input only. The time to live for this Consent from when it is created. format: google-duration type: string userId: description: Required. User's UUID provided by the client. type: string type: object Image: description: Raw bytes representing consent artifact content. properties: gcsUri: description: 'Input only. Points to a Cloud Storage URI containing the consent artifact content. The URI must be in the following format: `gs://{bucket_id}/{object_id}`. The Cloud Healthcare API service account must have the `roles/storage.objectViewer` Cloud IAM role for this Cloud Storage location. The consent artifact content at this URI is copied to a Cloud Storage location managed by the Cloud Healthcare API. Responses to fetching requests return the consent artifact content in raw_bytes.' type: string rawBytes: description: Consent artifact content represented as a stream of bytes. This field is populated when returned in GetConsentArtifact response, but not included in CreateConsentArtifact and ListConsentArtifact response. format: byte type: string type: object Hl7V2StoreMetric: description: Count of messages and total storage size by type for a given HL7 store. properties: count: description: The total count of HL7v2 messages in the store for the given message type. format: int64 type: string messageType: description: The Hl7v2 message type this metric applies to, such as `ADT` or `ORU`. type: string structuredStorageSizeBytes: description: The total amount of structured storage used by HL7v2 messages of this message type in the store. format: int64 type: string type: object ListConsentsResponse: properties: consents: description: The returned Consents. The maximum number of Consents returned is determined by the value of page_size in the ListConsentsRequest. items: $ref: '#/components/schemas/Consent' type: array nextPageToken: description: Token to retrieve the next page of results, or empty if there are no more results in the list. type: string type: object ListMessagesResponse: description: Lists the messages in the specified HL7v2 store. properties: hl7V2Messages: description: The returned Messages. Won't be more Messages than the value of page_size in the request. See view for populated fields. items: $ref: '#/components/schemas/Message' type: array nextPageToken: description: Token to retrieve the next page of results or empty if there are no more results in the list. type: string type: object RejectConsentRequest: description: Rejects the latest revision of the specified Consent by committing a new revision with `state` updated to `REJECTED`. If the latest revision of the given Consent is in the `REJECTED` state, no new revision is committed. properties: consentArtifact: description: Optional. The resource name of the Consent artifact that contains documentation of the user's rejection of the draft Consent, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consentArtifacts/{consent_artifact_id}`. If the draft Consent had a Consent artifact, this Consent artifact overwrites it. type: string type: object ConsentAccessorScope: description: The accessor scope that describes who can access, for what purpose, in which environment. properties: actor: description: An individual, group, or access role that identifies the accessor or a characteristic of the accessor. This can be a resource ID (such as `{resourceType}/{id}`) or an external URI. This value must be present. type: string environment: description: An abstract identifier that describes the environment or conditions under which the accessor is acting. Can be “*” if it applies to all environments. type: string purpose: description: The intent of data use. Can be “*” if it applies to all purposes. type: string type: object Vertex: description: A 2D coordinate in an image. The origin is the top-left. properties: x: description: X coordinate. format: float type: number y: description: Y coordinate. format: float type: number type: object Hl7SchemaConfig: description: Root config message for HL7v2 schema. This contains a schema structure of groups and segments, and filters that determine which messages to apply the schema structure to. properties: messageSchemaConfigs: additionalProperties: $ref: '#/components/schemas/SchemaGroup' description: Map from each HL7v2 message type and trigger event pair, such as ADT_A04, to its schema configuration root group. type: object version: description: Each VersionSource is tested and only if they all match is the schema used for the message. items: $ref: '#/components/schemas/VersionSource' type: array type: object Status: description: 'The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).' properties: code: description: The status code, which should be an enum value of google.rpc.Code. format: int32 type: integer details: description: A list of messages that carry the error details. There is a common set of message types for APIs to use. items: additionalProperties: description: Properties of the object. Contains field @type with type URL. type: object type: array message: description: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. type: string type: object SensitiveTextAnnotation: description: A TextAnnotation specifies a text range that includes sensitive information. properties: details: additionalProperties: $ref: '#/components/schemas/Detail' description: Maps from a resource slice. For example, FHIR resource field path to a set of sensitive text findings. For example, Appointment.Narrative text1 --> {findings_1, findings_2, findings_3} type: object type: object LinkedEntity: description: EntityMentions can be linked to multiple entities using a LinkedEntity message lets us add other fields, e.g. confidence. properties: entityId: description: entity_id is a concept unique identifier. These are prefixed by a string that identifies the entity coding system, followed by the unique identifier within that system. For example, "UMLS/C0000970". This also supports ad hoc entities, which are formed by normalizing entity mention content. type: string type: object DicomStoreMetrics: description: DicomStoreMetrics contains metrics describing a DICOM store. properties: blobStorageSizeBytes: description: Total blob storage bytes for all instances in the store. format: int64 type: string instanceCount: description: Number of instances in the store. format: int64 type: string name: description: Resource name of the DICOM store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. type: string seriesCount: description: Number of series in the store. format: int64 type: string structuredStorageSizeBytes: description: Total structured storage bytes for all instances in the store. format: int64 type: string studyCount: description: Number of studies in the store. format: int64 type: string type: object ResourceAnnotation: description: Resource level annotation. properties: label: description: A description of the annotation record. type: string type: object DateShiftConfig: description: Shift a date forward or backward in time by a random amount which is consistent for a given patient and crypto key combination. properties: cryptoKey: description: An AES 128/192/256 bit key. The date shift is computed based on this key and the patient ID. If the patient ID is empty for a DICOM resource, the date shift is computed based on this key and the study instance UID. If `crypto_key` is not set, then `kms_wrapped` is used to calculate the date shift. If neither is set, a default key is generated for each de-identify operation. Must not be set if `kms_wrapped` is set. format: byte type: string kmsWrapped: $ref: '#/components/schemas/KmsWrappedCryptoKey' description: KMS wrapped key. If `kms_wrapped` is not set, then `crypto_key` is used to calculate the date shift. If neither is set, a default key is generated for each de-identify operation. Must not be set if `crypto_key` is set. type: object FhirStore: description: Represents a FHIR store. properties: complexDataTypeReferenceParsing: description: 'Enable parsing of references within complex FHIR data types such as Extensions. If this value is set to ENABLED, then features like referential integrity and Bundle reference rewriting apply to all references. If this flag has not been specified the behavior of the FHIR store will not change, references in complex data types will not be parsed. New stores will have this value set to ENABLED after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources.' enum: - COMPLEX_DATA_TYPE_REFERENCE_PARSING_UNSPECIFIED - DISABLED - ENABLED type: string defaultSearchHandlingStrict: description: 'If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`.' type: boolean disableReferentialIntegrity: description: Immutable. Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store creation. The default value is false, meaning that the API enforces referential integrity and fails the requests that result in inconsistent state in the FHIR store. When this field is set to true, the API skips referential integrity checks. Consequently, operations that rely on references, such as GetPatientEverything, do not return all the results if broken references exist. type: boolean disableResourceVersioning: description: Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, which is the default behavior, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. type: boolean enableUpdateCreate: description: Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. type: boolean labels: additionalProperties: type: string description: 'User-supplied key-value pairs used to organize FHIR stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store.' type: object name: description: Output only. Identifier. Resource name of the FHIR store, of the form `projects/{project_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. type: string notificationConfig: $ref: '#/components/schemas/NotificationConfig' deprecated: true description: Deprecated. Use `notification_configs` instead. If non-empty, publish all resource modifications of this FHIR store to this destination. The Pub/Sub message attributes contain a map with a string describing the action that has triggered the notification. For example, "action":"CreateResource". notificationConfigs: description: Specifies where and whether to send notifications upon changes to a FHIR store. items: $ref: '#/components/schemas/FhirNotificationConfig' type: array streamConfigs: description: A list of streaming configs that configure the destinations of streaming export for every resource mutation in this FHIR store. Each store is allowed to have up to 10 streaming configs. After a new config is added, the next resource mutation is streamed to the new location in addition to the existing ones. When a location is removed from the list, the server stops streaming to that location. Before adding a new config, you must add the required [`bigquery.dataEditor`](https://cloud.google.com/bigquery/docs/access-control#bigquery.dataEditor) role to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/iam/docs/service-accounts). Some lag (typically on the order of dozens of seconds) is expected before the results show up in the streaming destination. items: $ref: '#/components/schemas/StreamConfig' type: array validationConfig: $ref: '#/components/schemas/ValidationConfig' description: Configuration for how to validate incoming FHIR resources against configured profiles. version: description: Required. Immutable. The FHIR specification version that this FHIR store supports natively. This field is immutable after store creation. Requests are rejected if they contain FHIR resources of a different version. Version is required for every FHIR store. enum: - VERSION_UNSPECIFIED - DSTU2 - STU3 - R4 type: string type: object TextConfig: properties: additionalTransformations: description: Transformations to apply to the detected data, overridden by `exclude_info_types`. items: $ref: '#/components/schemas/InfoTypeTransformation' type: array excludeInfoTypes: description: InfoTypes to skip transforming, overriding `additional_transformations`. items: type: string type: array transformations: description: The transformations to apply to the detected data. Deprecated. Use `additional_transformations` instead. items: $ref: '#/components/schemas/InfoTypeTransformation' type: array type: object Result: description: The consent evaluation result for a single `data_id`. properties: consentDetails: additionalProperties: $ref: '#/components/schemas/ConsentEvaluation' description: The resource names of all evaluated Consents mapped to their evaluation. type: object consented: description: Whether the resource is consented for the given use. type: boolean dataId: description: The unique identifier of the evaluated resource. type: string type: object ListAnnotationsResponse: description: Lists the Annotations in the specified Annotation store. properties: annotations: description: The returned Annotations. Won't be more values than the value of page_size in the request. See `AnnotationView` in the request for populated fields. items: $ref: '#/components/schemas/Annotation' type: array nextPageToken: description: Token to retrieve the next page of results or empty if there are no more results in the list. type: string type: object Expr: description: 'Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != ''private'' && document.type != ''internal''" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "''New message received at '' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.' properties: description: description: Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. type: string expression: description: Textual representation of an expression in Common Expression Language syntax. type: string location: description: Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. type: string title: description: Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. type: string type: object ValidationConfig: description: Contains the configuration for FHIR profiles and validation. properties: disableFhirpathValidation: description: Whether to disable FHIRPath validation for incoming resources. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. type: boolean disableProfileValidation: description: Whether to disable profile validation for this FHIR store. Set this to true to disable checking incoming resources for conformance against structure definitions in this FHIR store. type: boolean disableReferenceTypeValidation: description: Whether to disable reference type validation for incoming resources. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. type: boolean disableRequiredFieldValidation: description: Whether to disable required fields validation for incoming resources. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. type: boolean enabledImplementationGuides: description: 'A list of implementation guide URLs in this FHIR store that are used to configure the profiles to use for validation. For example, to use the US Core profiles for validation, set `enabled_implementation_guides` to `["http://hl7.org/fhir/us/core/ImplementationGuide/ig"]`. If `enabled_implementation_guides` is empty or omitted, then incoming resources are only required to conform to the base FHIR profiles. Otherwise, a resource must conform to at least one profile listed in the `global` property of one of the enabled ImplementationGuides. The Cloud Healthcare API does not currently enforce all of the rules in a StructureDefinition. The following rules are supported: - min/max - minValue/maxValue - maxLength - type - fixed[x] - pattern[x] on simple types - slicing, when using "value" as the discriminator type When a URL cannot be resolved (for example, in a type assertion), the server does not return an error.' items: type: string type: array type: object TimeRange: description: Apply consents given by patients whose most recent consent changes are in the time range. Note that after identifying these patients, the server applies all Consent resources given by those patients, not just the Consent resources within the timestamp in the range. properties: end: description: Optional. The latest consent change time, in format YYYY-MM-DDThh:mm:ss.sss+zz:zz If not specified, the system uses the time when ApplyConsents was called. type: string start: description: Optional. The earliest consent change time, in format YYYY-MM-DDThh:mm:ss.sss+zz:zz If not specified, the system uses the FHIR store creation time. type: string type: object ApplyAdminConsentsRequest: description: Request to apply the admin Consent resources for the specified FHIR store. properties: newConsentsList: $ref: '#/components/schemas/AdminConsents' description: 'A new list of admin Consent resources to be applied. Any existing enforced Consents, which are specified in `consent_config.enforced_admin_consents` of the FhirStore, that are not part of this list will be disabled. An empty list is equivalent to clearing or disabling all Consents enforced on the FHIR store. When a FHIR store has `disable_resource_versioning=true` and this list contains a Consent resource that exists in `consent_config.enforced_admin_consents`, the method enforces any updates to the existing resource since the last enforcement. If the existing resource hasn''t been updated since the last enforcement, the resource is unaffected. After the method finishes, the resulting consent enforcement model is determined by the contents of the Consent resource(s) when the method was called: * When `disable_resource_versioning=true`, the result is identical to the current resource(s) in the FHIR store. * When `disable_resource_versioning=false`, the result is based on the historical version(s) of the Consent resource(s) at the point in time when the method was called. At most 200 Consents can be specified.' validateOnly: description: 'If true, the method only validates Consent resources to make sure they are supported. Otherwise, the method applies the aggregate consent information to update the enforcement model and reindex the FHIR resources. If all Consent resources can be applied successfully, the ApplyAdminConsentsResponse is returned containing the following fields: * `consent_apply_success` to indicate the number of Consent resources applied. * `affected_resources` to indicate the number of resources that might have had their consent access changed. If, however, one or more Consent resources are unsupported or cannot be applied, the method fails and ApplyAdminConsentsErrorDetail is is returned with details about the unsupported Consent resources.' type: boolean type: object DeidentifyDatasetRequest: description: Redacts identifying information from the specified dataset. properties: config: $ref: '#/components/schemas/DeidentifyConfig' description: Deidentify configuration. Only one of `config` and `gcs_config_uri` can be specified. destinationDataset: description: Required. The name of the dataset resource to create and write the redacted data to. * The destination dataset must not exist. * The destination dataset must be in the same location as the source dataset. De-identifying data across multiple locations is not supported. type: string gcsConfigUri: description: Cloud Storage location to read the JSON cloud.healthcare.deidentify.DeidentifyConfig from, overriding the default config. Must be of the form `gs://{bucket_id}/path/to/object`. The Cloud Storage location must grant the Cloud IAM role `roles/storage.objectViewer` to the project's Cloud Healthcare Service Agent service account. Only one of `config` and `gcs_config_uri` can be specified. type: string type: object CancelOperationRequest: description: The request message for Operations.CancelOperation. properties: {} type: object GoogleCloudHealthcareV1ConsentPolicy: description: Represents a user's consent in terms of the resources that can be accessed and under what conditions. properties: authorizationRule: $ref: '#/components/schemas/Expr' description: Required. The request conditions to meet to grant access. In addition to any supported comparison operators, authorization rules may have `IN` operator as well as at most 10 logical operators that are limited to `AND` (`&&`), `OR` (`||`). resourceAttributes: description: The resources that this policy applies to. A resource is a match if it matches all the attributes listed here. If empty, this policy applies to all User data mappings for the given user. items: $ref: '#/components/schemas/Attribute' type: array type: object GoogleCloudHealthcareV1FhirBigQueryDestination: description: The configuration for exporting to BigQuery. properties: datasetUri: description: BigQuery URI to an existing dataset, up to 2000 characters long, in the format `bq://projectId.bqDatasetId`. type: string force: description: If this flag is `TRUE`, all tables are deleted from the dataset before the new exported tables are written. If the flag is not set and the destination dataset contains tables, the export call returns an error. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. type: boolean schemaConfig: $ref: '#/components/schemas/SchemaConfig' description: The configuration for the exported BigQuery schema. writeDisposition: description: Determines if existing data in the destination dataset is overwritten, appended to, or not written if the tables contain data. If a write_disposition is specified, the `force` parameter is ignored. enum: - WRITE_DISPOSITION_UNSPECIFIED - WRITE_EMPTY - WRITE_TRUNCATE - WRITE_APPEND type: string type: object ListConsentArtifactsResponse: properties: consentArtifacts: description: The returned Consent artifacts. The maximum number of artifacts returned is determined by the value of page_size in the ListConsentArtifactsRequest. items: $ref: '#/components/schemas/ConsentArtifact' type: array nextPageToken: description: Token to retrieve the next page of results, or empty if there are no more results in the list. type: string type: object GoogleCloudHealthcareV1DicomStreamConfig: description: StreamConfig specifies configuration for a streaming DICOM export. properties: bigqueryDestination: $ref: '#/components/schemas/GoogleCloudHealthcareV1DicomBigQueryDestination' description: 'Results are appended to this table. The server creates a new table in the given BigQuery dataset if the specified table does not exist. To enable the Cloud Healthcare API to write to your BigQuery table, you must give the Cloud Healthcare API service account the bigquery.dataEditor role. The service account is: `service-{PROJECT_NUMBER}@gcp-sa-healthcare.iam.gserviceaccount.com`. The PROJECT_NUMBER identifies the project that the DICOM store resides in. To get the project number, go to the Cloud Console Dashboard. It is recommended to not have a custom schema in the destination table which could conflict with the schema created by the Cloud Healthcare API. Instance deletions are not applied to the destination table. The destination''s table schema will be automatically updated in case a new instance''s data is incompatible with the current schema. The schema should not be updated manually as this can cause incompatibilies that cannot be resolved automatically. One resolution in this case is to delete the incompatible table and let the server recreate one, though the newly created table only contains data after the table recreation. BigQuery imposes a 1 MB limit on streaming insert row size, therefore any instance that generates more than 1 MB of BigQuery data will not be streamed. If an instance cannot be streamed to BigQuery, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)).' type: object FhirNotificationConfig_2: description: Contains the configuration for FHIR notifications. properties: pubsubTopic: description: 'The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. The notification is a `PubsubMessage` with the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time when the message was published. Note that notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. The Cloud Healthcare API service account, service-@gcp-sa-healthcare.iam.gserviceaccount.com, must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail (https://cloud.google.com/healthcare-api/docs/permissions-healthcare-api-gcp-products#dicom_fhir_and_hl7v2_store_cloud_pubsub_permissions). If a notification can''t be published to Pub/Sub, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare-api/docs/how-tos/logging).' type: string sendFullResource: description: Whether to send full FHIR resource to this Pub/Sub topic for Create and Update operation. Note that setting this to true does not guarantee that all resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full resource as a separate operation. type: boolean sendPreviousResourceOnDelete: description: Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation. type: boolean type: object CharacterMaskConfig: description: Mask a string by replacing its characters with a fixed character. properties: maskingCharacter: description: Character to mask the sensitive values. If not supplied, defaults to "*". type: string type: object Segment: description: A segment in a structured format. properties: fields: additionalProperties: type: string description: 'A mapping from the positional location to the value. The key string uses zero-based indexes separated by dots to identify Fields, components and sub-components. A bracket notation is also used to identify different instances of a repeated field. Regex for key: (\d+)(\[\d+\])?(.\d+)?(.\d+)? Examples of (key, value) pairs: * (0.1, "hemoglobin") denotes that the first component of Field 0 has the value "hemoglobin". * (1.1.2, "CBC") denotes that the second sub-component of the first component of Field 1 has the value "CBC". * (1[0].1, "HbA1c") denotes that the first component of the first Instance of Field 1, which is repeated, has the value "HbA1c".' type: object segmentId: description: A string that indicates the type of segment. For example, EVN or PID. type: string setId: description: Set ID for segments that can be in a set. This can be empty if it's missing or isn't applicable. type: string type: object TextSpan: description: A span of text in the provided document. properties: beginOffset: description: The unicode codepoint index of the beginning of this span. format: int32 type: integer content: description: The original text contained in this span. type: string type: object FilterList: description: List of infoTypes to be filtered. properties: infoTypes: description: These infoTypes are based on after the `eval_info_type_mapping` and `golden_info_type_mapping`. items: type: string type: array type: object ActivateConsentRequest: description: Activates the latest revision of the specified Consent by committing a new revision with `state` updated to `ACTIVE`. If the latest revision of the given Consent is in the `ACTIVE` state, no new revision is committed. A FAILED_PRECONDITION error occurs if the latest revision of the given consent is in the `REJECTED` or `REVOKED` state. properties: consentArtifact: description: Required. The resource name of the Consent artifact that contains documentation of the user's consent, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consentArtifacts/{consent_artifact_id}`. If the draft Consent had a Consent artifact, this Consent artifact overwrites it. type: string expireTime: description: Timestamp in UTC of when this Consent is considered expired. format: google-datetime type: string ttl: description: The time to live for this Consent from when it is marked as active. format: google-duration type: string type: object FhirStoreMetric: description: Count of resources and total storage size by type for a given FHIR store. properties: count: description: The total count of FHIR resources in the store of this resource type. format: int64 type: string resourceType: description: The FHIR resource type this metric applies to. type: string structuredStorageSizeBytes: description: The total amount of structured storage used by FHIR resources of this resource type in the store. format: int64 type: string type: object SchemaPackage: description: A schema package contains a set of schemas and type definitions. properties: ignoreMinOccurs: description: Flag to ignore all min_occurs restrictions in the schema. This means that incoming messages can omit any group, segment, field, component, or subcomponent. type: boolean schemas: description: Schema configs that are layered based on their VersionSources that match the incoming message. Schema configs present in higher indices override those in lower indices with the same message type and trigger event if their VersionSources all match an incoming message. items: $ref: '#/components/schemas/Hl7SchemaConfig' type: array schematizedParsingType: description: Determines how messages that fail to parse are handled. enum: - SCHEMATIZED_PARSING_TYPE_UNSPECIFIED - SOFT_FAIL - HARD_FAIL type: string types: description: Schema type definitions that are layered based on their VersionSources that match the incoming message. Type definitions present in higher indices override those in lower indices with the same type name if their VersionSources all match an incoming message. items: $ref: '#/components/schemas/Hl7TypesConfig' type: array unexpectedSegmentHandling: description: Determines how unexpected segments (segments not matched to the schema) are handled. enum: - UNEXPECTED_SEGMENT_HANDLING_MODE_UNSPECIFIED - FAIL - SKIP - PARSE type: string type: object ListOperationsResponse: description: The response message for Operations.ListOperations. properties: nextPageToken: description: The standard List next-page token. type: string operations: description: A list of operations that matches the specified filter in the request. items: $ref: '#/components/schemas/Operation' type: array type: object ImageConfig: description: Specifies how to handle de-identification of image pixels. properties: textRedactionMode: description: Determines how to redact text from image. enum: - TEXT_REDACTION_MODE_UNSPECIFIED - REDACT_ALL_TEXT - REDACT_SENSITIVE_TEXT - REDACT_NO_TEXT type: string type: object SchemaGroup: description: An HL7v2 logical group construct. properties: choice: description: True indicates that this is a choice group, meaning that only one of its segments can exist in a given message. type: boolean maxOccurs: description: The maximum number of times this group can be repeated. 0 or -1 means unbounded. format: int32 type: integer members: description: Nested groups and/or segments. items: $ref: '#/components/schemas/GroupOrSegment' type: array minOccurs: description: The minimum number of times this group must be present/repeated. format: int32 type: integer name: description: The name of this group. For example, "ORDER_DETAIL". type: string type: object FhirNotificationConfig: description: Contains the configuration for FHIR notifications. properties: pubsubTopic: description: 'The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. The notification is a `PubsubMessage` with the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time when the message was published. Note that notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. The Cloud Healthcare API service account, service-@gcp-sa-healthcare.iam.gserviceaccount.com, must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail (https://cloud.google.com/healthcare-api/docs/permissions-healthcare-api-gcp-products#dicom_fhir_and_hl7v2_store_cloud_pubsub_permissions). If a notification can''t be published to Pub/Sub, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare-api/docs/how-tos/logging).' type: string sendFullResource: description: Whether to send full FHIR resource to this Pub/Sub topic. type: boolean sendPreviousResourceOnDelete: description: Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation. type: boolean type: object Hl7V2NotificationConfig_2: description: Specifies where and whether to send notifications upon changes to a data store. properties: filter: description: 'Restricts notifications sent for messages matching a filter. If this is empty, all messages are matched. The following syntax is available: * A string field value can be written as text inside quotation marks, for example `"query text"`. The only valid relational operation for text fields is equality (`=`), where text is searched within the field, rather than having the field be equal to the text. For example, `"Comment = great"` returns messages with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it''s just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. 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":*`.' type: string pubsubTopic: description: 'The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. The notification is a `PubsubMessage` with the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time when the message was published. Note that notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. Cloud Healthcare API service account must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail. If a notification can''t be published to Pub/Sub, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging).' type: string type: object Empty: description: 'A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }' properties: {} type: object CreateMessageRequest: description: Creates a new message. properties: message: $ref: '#/components/schemas/Message' description: Required. HL7v2 message. type: object QueryAccessibleDataRequest: description: Queries all data_ids that are consented for a given use in the given consent store and writes them to a specified destination. The returned Operation includes a progress counter for the number of User data mappings processed. Errors are logged to Cloud Logging (see [Viewing error logs in Cloud Logging] (https://cloud.google.com/healthcare/docs/how-tos/logging) and [QueryAccessibleData] for a sample log entry). properties: gcsDestination: $ref: '#/components/schemas/GoogleCloudHealthcareV1ConsentGcsDestination' description: The Cloud Storage destination. The Cloud Healthcare API service account must have the `roles/storage.objectAdmin` Cloud IAM role for this Cloud Storage location. requestAttributes: additionalProperties: type: string description: The values of request attributes associated with this access request. type: object resourceAttributes: additionalProperties: type: string description: Optional. The values of resource attributes associated with the type of resources being requested. If no values are specified, then all resource types are included in the output. type: object type: object GoogleCloudHealthcareV1DicomBigQueryDestination: description: The BigQuery table where the server writes the output. properties: force: description: Use `write_disposition` instead. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. type: boolean tableUri: description: BigQuery URI to a table, up to 2000 characters long, in the format `bq://projectId.bqDatasetId.tableId` type: string writeDisposition: description: Determines whether the existing table in the destination is to be overwritten or appended to. If a write_disposition is specified, the `force` parameter is ignored. enum: - WRITE_DISPOSITION_UNSPECIFIED - WRITE_EMPTY - WRITE_TRUNCATE - WRITE_APPEND type: string type: object AttributeDefinition: description: A client-defined consent attribute. properties: allowedValues: description: Required. Possible values for the attribute. The number of allowed values must not exceed 500. An empty list is invalid. The list can only be expanded after creation. items: type: string type: array category: description: Required. The category of the attribute. The value of this field cannot be changed after creation. enum: - CATEGORY_UNSPECIFIED - RESOURCE - REQUEST type: string consentDefaultValues: description: Optional. Default values of the attribute in Consents. If no default values are specified, it defaults to an empty value. items: type: string type: array dataMappingDefaultValue: description: Optional. Default value of the attribute in User data mappings. If no default value is specified, it defaults to an empty value. This field is only applicable to attributes of the category `RESOURCE`. type: string description: description: Optional. A description of the attribute. type: string name: description: Identifier. Resource name of the Attribute definition, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/attributeDefinitions/{attribute_definition_id}`. Cannot be changed after creation. type: string type: object DicomStore_2: description: Represents a DICOM store. properties: labels: additionalProperties: type: string description: 'User-supplied key-value pairs used to organize DICOM stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store.' type: object name: description: Identifier. Resource name of the DICOM store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. type: string notificationConfig: $ref: '#/components/schemas/NotificationConfig' description: Notification destination for new DICOM instances. Supplied by the client. streamConfigs: description: Optional. A list of streaming configs used to configure the destination of streaming exports for every DICOM instance insertion in this DICOM store. After a new config is added to `stream_configs`, DICOM instance insertions are streamed to the new destination. When a config is removed from `stream_configs`, the server stops streaming to that destination. Each config must contain a unique destination. items: $ref: '#/components/schemas/GoogleCloudHealthcareV1beta1DicomStreamConfig' type: array type: object AnalyzeEntitiesRequest: description: The request to analyze healthcare entities in a document. properties: alternativeOutputFormat: description: Optional. Alternative output format to be generated based on the results of analysis. enum: - ALTERNATIVE_OUTPUT_FORMAT_UNSPECIFIED - FHIR_BUNDLE type: string documentContent: description: document_content is a document to be annotated. type: string licensedVocabularies: description: A list of licensed vocabularies to use in the request, in addition to the default unlicensed vocabularies. items: enum: - LICENSED_VOCABULARY_UNSPECIFIED - ICD10CM - SNOMEDCT_US type: string type: array type: object ArchiveUserDataMappingResponse: description: Archives the specified User data mapping. properties: {} type: object Signature: description: User signature. properties: image: $ref: '#/components/schemas/Image' description: Optional. An image of the user's signature. metadata: additionalProperties: type: string description: Optional. Metadata associated with the user's signature. For example, the user's name or the user's title. type: object signatureTime: description: Optional. Timestamp of the signature. format: google-datetime type: string userId: description: Required. User's UUID provided by the client. type: string type: object AuditConfig: description: 'Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.' properties: auditLogConfigs: description: The configuration for logging of each type of permission. items: $ref: '#/components/schemas/AuditLogConfig' type: array service: description: Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. type: string type: object BlobStorageSettings: description: Settings for data stored in Blob storage. properties: blobStorageClass: description: The Storage class in which the Blob data is stored. enum: - BLOB_STORAGE_CLASS_UNSPECIFIED - STANDARD - NEARLINE - COLDLINE - ARCHIVE type: string type: object EvaluateUserConsentsRequest: description: 'Evaluate a user''s Consents for all matching User data mappings. Note: User data mappings are indexed asynchronously, causing slight delays between the time mappings are created or updated and when they are included in EvaluateUserConsents results.' properties: consentList: $ref: '#/components/schemas/ConsentList' description: Optional. Specific Consents to evaluate the access request against. These Consents must have the same `user_id` as the User data mappings being evalauted, must exist in the current `consent_store`, and must have a `state` of either `ACTIVE` or `DRAFT`. A maximum of 100 Consents can be provided here. If unspecified, all `ACTIVE` unexpired Consents in the current `consent_store` will be evaluated. pageSize: 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. format: int32 type: integer pageToken: description: Optional. Token to retrieve the next page of results, or empty to get the first page. type: string requestAttributes: additionalProperties: type: string description: Required. The values of request attributes associated with this access request. type: object resourceAttributes: additionalProperties: type: string description: Optional. The values of resource attributes associated with the resources being requested. If no values are specified, then all resources are queried. type: object responseView: description: Optional. The view for EvaluateUserConsentsResponse. If unspecified, defaults to `BASIC` and returns `consented` as `TRUE` or `FALSE`. enum: - RESPONSE_VIEW_UNSPECIFIED - BASIC - FULL type: string userId: description: Required. User ID to evaluate consents for. type: string type: object EntityMention: description: An entity mention in the document. properties: certaintyAssessment: $ref: '#/components/schemas/Feature' description: 'The certainty assessment of the entity mention. Its value is one of: LIKELY, SOMEWHAT_LIKELY, UNCERTAIN, SOMEWHAT_UNLIKELY, UNLIKELY, CONDITIONAL' confidence: description: The model's confidence in this entity mention annotation. A number between 0 and 1. format: double type: number linkedEntities: description: linked_entities are candidate ontological concepts that this entity mention may refer to. They are sorted by decreasing confidence. items: $ref: '#/components/schemas/LinkedEntity' type: array mentionId: description: mention_id uniquely identifies each entity mention in a single response. type: string subject: $ref: '#/components/schemas/Feature' description: 'The subject this entity mention relates to. Its value is one of: PATIENT, FAMILY_MEMBER, OTHER' temporalAssessment: $ref: '#/components/schemas/Feature' description: 'How this entity mention relates to the subject temporally. Its value is one of: CURRENT, CLINICAL_HISTORY, FAMILY_HISTORY, UPCOMING, ALLERGY' text: $ref: '#/components/schemas/TextSpan' description: text is the location of the entity mention in the document. type: description: 'The semantic type of the entity: UNKNOWN_ENTITY_TYPE, ALONE, ANATOMICAL_STRUCTURE, ASSISTED_LIVING, BF_RESULT, BM_RESULT, BM_UNIT, BM_VALUE, BODY_FUNCTION, BODY_MEASUREMENT, COMPLIANT, DOESNOT_FOLLOWUP, FAMILY, FOLLOWSUP, LABORATORY_DATA, LAB_RESULT, LAB_UNIT, LAB_VALUE, MEDICAL_DEVICE, MEDICINE, MED_DOSE, MED_DURATION, MED_FORM, MED_FREQUENCY, MED_ROUTE, MED_STATUS, MED_STRENGTH, MED_TOTALDOSE, MED_UNIT, NON_COMPLIANT, OTHER_LIVINGSTATUS, PROBLEM, PROCEDURE, PROCEDURE_RESULT, PROC_METHOD, REASON_FOR_NONCOMPLIANCE, SEVERITY, SUBSTANCE_ABUSE, UNCLEAR_FOLLOWUP.' type: string type: object PubsubDestination: description: The Pub/Sub output destination. The Cloud Healthcare Service Agent requires the `roles/pubsub.publisher` Cloud IAM role on the Pub/Sub topic. properties: pubsubTopic: description: 'The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that Pub/Sub messages are published on. Supplied by the client. The `PubsubMessage` contains the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time when the message was published. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. The Cloud Healthcare API service account, service-PROJECT_NUMBER@gcp-sa-healthcare.iam.gserviceaccount.com, must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail.' type: string type: object ListDicomStoresResponse: description: Lists the DICOM stores in the given dataset. properties: dicomStores: description: The returned DICOM stores. Won't be more DICOM stores than the value of page_size in the request. items: $ref: '#/components/schemas/DicomStore' type: array nextPageToken: description: Token to retrieve the next page of results or empty if there are no more results in the list. type: string type: object StructuredStorageInfo: description: StructuredStorageInfo contains details about the data stored in Structured Storage for the referenced resource. properties: sizeBytes: description: Size in bytes of data stored in structured storage. format: int64 type: string type: object SearchResourcesRequest: description: Request to search the resources in the specified FHIR store. properties: resourceType: 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)). type: string type: object ApplyConsentsRequest: description: Request to apply the Consent resources for the specified FHIR store. properties: patientScope: $ref: '#/components/schemas/PatientScope' description: Optional. Scope down to a list of patients. timeRange: $ref: '#/components/schemas/TimeRange' description: Optional. Scope down to patients whose most recent consent changes are in the time range. Can only be used with a versioning store (i.e. when disable_resource_versioning is set to false). validateOnly: description: Optional. If true, the method only validates Consent resources to make sure they are supported. When the operation completes, ApplyConsentsResponse is returned where `consent_apply_success` and `consent_apply_failure` indicate supported and unsupported (or invalid) Consent resources, respectively. Otherwise, the method propagates the aggregate consensual information to the patient's resources. Upon success, `affected_resources` in the ApplyConsentsResponse indicates the number of resources that may have consensual access changed. type: boolean type: object RollbackFhirResourceFilteringFields: properties: metadataFilter: description: 'Optional. A filter expression that matches data in the `Resource.meta` element. Supports all filters in [AIP-160](https://google.aip.dev/160) except the "has" (`:`) operator. Supports the following custom functions: * `tag("") = ""` for tag filtering. * `extension_value_ts("") = ` for filtering extensions with a timestamp, where `` is a Unix timestamp. Supports the `>`, `<`, `<=`, `>=`, and `!=` comparison operators.' type: string operationIds: description: Optional. A list of operation IDs to roll back. items: format: uint64 type: string type: array type: object EvaluateAnnotationStoreRequest: description: Request to evaluate an Annotation store against a ground truth [Annotation store]. properties: bigqueryDestination: $ref: '#/components/schemas/GoogleCloudHealthcareV1beta1AnnotationBigQueryDestination' description: The BigQuery table where the server writes the output. BigQueryDestination requires the `roles/bigquery.dataEditor` and `roles/bigquery.jobUser` Cloud IAM roles. evalInfoTypeMapping: additionalProperties: type: string description: 'Optional. InfoType mapping for `eval_store`. Different resources can map to the same infoType. For example, `PERSON_NAME`, `PERSON`, `NAME`, and `HUMAN` are different. To map all of these into a single infoType (such as `PERSON_NAME`), specify the following mapping: ``` info_type_mapping["PERSON"] = "PERSON_NAME" info_type_mapping["NAME"] = "PERSON_NAME" info_type_mapping["HUMAN"] = "PERSON_NAME" ``` Unmentioned infoTypes, such as `DATE`, are treated as identity mapping. For example: ``` info_type_mapping["DATE"] = "DATE" ``` InfoTypes are case-insensitive.' type: object goldenInfoTypeMapping: additionalProperties: type: string description: Optional. Similar to `eval_info_type_mapping`, infoType mapping for `golden_store`. type: object goldenStore: description: Required. The Annotation store to use as ground truth, in the format of `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}`. type: string infoTypeConfig: $ref: '#/components/schemas/InfoTypeConfig' type: object ConsentStore: description: Represents a consent store. properties: defaultConsentTtl: description: Optional. Default time to live for Consents created in this store. Must be at least 24 hours. Updating this field will not affect the expiration time of existing consents. format: google-duration type: string enableConsentCreateOnUpdate: description: Optional. If `true`, UpdateConsent creates the Consent if it does not already exist. If unspecified, defaults to `false`. type: boolean labels: additionalProperties: type: string description: 'Optional. User-supplied key-value pairs used to organize consent stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62}. Label values must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63}. No more than 64 labels can be associated with a given store. For more information: https://cloud.google.com/healthcare/docs/how-tos/labeling-resources' type: object name: description: Identifier. Resource name of the consent store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}`. Cannot be changed after creation. type: string type: object Hl7V2Store: description: Represents an HL7v2 store. properties: labels: additionalProperties: type: string description: 'User-supplied key-value pairs used to organize HL7v2 stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store.' type: object name: description: Identifier. Resource name of the HL7v2 store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`. type: string notificationConfigs: description: A list of notification configs. Each configuration uses a filter to determine whether to publish a message (both Ingest & Create) on the corresponding notification destination. Only the message name is sent as part of the notification. Supplied by the client. items: $ref: '#/components/schemas/Hl7V2NotificationConfig' type: array parserConfig: $ref: '#/components/schemas/ParserConfig' description: The configuration for the parser. It determines how the server parses the messages. rejectDuplicateMessage: description: Determines whether to reject duplicate messages. A duplicate message is a message with the same raw bytes as a message that has already been ingested/created in this HL7v2 store. The default value is false, meaning that the store accepts the duplicate messages and it also returns the same ACK message in the IngestMessageResponse as has been returned previously. Note that only one resource is created in the store. When this field is set to true, CreateMessage/IngestMessage requests with a duplicate message will be rejected by the store, and IngestMessageErrorDetail returns a NACK message upon rejection. type: boolean type: object ImageAnnotation: description: Image annotation. properties: boundingPolys: description: The list of polygons outlining the sensitive regions in the image. items: $ref: '#/components/schemas/BoundingPoly' type: array frameIndex: description: 0-based index of the image frame. For example, an image frame in a DICOM instance. format: int32 type: integer type: object CloudHealthcareSource: description: Cloud Healthcare API resource. properties: name: description: Full path of a Cloud Healthcare API resource. type: string type: object ListFhirStoresResponse: description: Lists the FHIR stores in the given dataset. properties: fhirStores: description: The returned FHIR stores. Won't be more FHIR stores than the value of page_size in the request. items: $ref: '#/components/schemas/FhirStore' type: array nextPageToken: description: Token to retrieve the next page of results or empty if there are no more results in the list. type: string type: object StreamConfig_2: description: Contains configuration for streaming FHIR export. properties: bigqueryDestination: $ref: '#/components/schemas/GoogleCloudHealthcareV1beta1FhirBigQueryDestination' description: The destination BigQuery structure that contains both the dataset location and corresponding schema config. The output is organized in one table per resource type. The server reuses the existing tables (if any) that are named after the resource types, e.g. "Patient", "Observation". When there is no existing table for a given resource type, the server attempts to create one. When a table schema doesn't align with the schema config, either because of existing incompatible schema or out of band incompatible modification, the server does not stream in new data. One resolution in this case is to delete the incompatible table and let the server recreate one, though the newly created table only contains data after the table recreation. BigQuery imposes a 1 MB limit on streaming insert row size, therefore any resource mutation that generates more than 1 MB of BigQuery data will not be streamed. Results are written to BigQuery tables according to the parameters in BigQueryDestination.WriteDisposition. Different versions of the same resource are distinguishable by the meta.versionId and meta.lastUpdated columns. The operation (CREATE/UPDATE/DELETE) that results in the new version is recorded in the meta.tag. The tables contain all historical resource versions since streaming was enabled. For query convenience, the server also creates one view per table of the same name containing only the current resource version. The streamed data in the BigQuery dataset is not guaranteed to be completely unique. The combination of the id and meta.versionId columns should ideally identify a single unique row. But in rare cases, duplicates may exist. At query time, users may use the SQL select statement to keep only one of the duplicate rows given an id and meta.versionId pair. Alternatively, the server created view mentioned above also filters out duplicates. If a resource mutation cannot be streamed to BigQuery, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). deidentifiedStoreDestination: $ref: '#/components/schemas/DeidentifiedStoreDestination' description: The destination FHIR store for de-identified resources. After this field is added, all subsequent creates/updates/patches to the source store will be de-identified using the provided configuration and applied to the destination store. Importing resources to the source store will not trigger the streaming. If the source store already contains resources when this option is enabled, those resources will not be copied to the destination store unless they are subsequently updated. This may result in invalid references in the destination store. Before adding this config, you must grant the healthcare.fhirResources.update permission on the destination store to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/healthcare/docs/how-tos/permissions-healthcare-api-gcp-products#the_cloud_healthcare_service_agent). The destination store must set enable_update_create to true. The destination store must have disable_referential_integrity set to true. If a resource cannot be de-identified, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). resourceTypes: description: Supply a FHIR resource type (such as "Patient" or "Observation"). See https://www.hl7.org/fhir/valueset-resource-types.html for a list of all FHIR resource types. The server treats an empty list as an intent to stream all the supported resource types in this FHIR store. items: type: string type: array type: object InfoTypeConfig: description: Specifies how to use infoTypes for evaluation. For example, a user might only want to evaluate `PERSON`, `LOCATION`, and `AGE`. properties: evaluateList: $ref: '#/components/schemas/FilterList' ignoreList: $ref: '#/components/schemas/FilterList' strictMatching: description: 'If `TRUE`, infoTypes described by `filter` are used for evaluation. Otherwise, infoTypes are not considered for evaluation. For example: * Annotated text: "Toronto is a location" * Finding 1: `{"infoType": "PERSON", "quote": "Toronto", "start": 0, "end": 7}` * Finding 2: `{"infoType": "CITY", "quote": "Toronto", "start": 0, "end": 7}` * Finding 3: `{}` * Ground truth: `{"infoType": "LOCATION", "quote": "Toronto", "start": 0, "end": 7}` When `strict_matching` is `TRUE`: * Finding 1: 1 false positive * Finding 2: 1 false positive * Finding 3: 1 false negative When `strict_matching` is `FALSE`: * Finding 1: 1 true positive * Finding 2: 1 true positive * Finding 3: 1 false negative' type: boolean type: object Attribute_2: description: An attribute value for a Consent or User data mapping. Each Attribute must have a corresponding AttributeDefinition in the consent store that defines the default and allowed values. properties: attributeDefinitionId: description: Indicates the name of an attribute defined in the consent store. type: string values: description: The value of the attribute. Must be an acceptable value as defined in the consent store. For example, if the consent store defines "data type" with acceptable values "questionnaire" and "step-count", when the attribute name is data type, this field must contain one of those values. items: type: string type: array type: object Hl7V2NotificationConfig: description: Specifies where and whether to send notifications upon changes to a data store. properties: filter: description: 'Restricts notifications sent for messages matching a filter. If this is empty, all messages are matched. The following syntax is available: * A string field value can be written as text inside quotation marks, for example `"query text"`. The only valid relational operation for text fields is equality (`=`), where text is searched within the field, rather than having the field be equal to the text. For example, `"Comment = great"` returns messages with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it''s just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. The following fields and functions are available for filtering: * `message_type`, from the MSH-9.1 field. For example, `NOT message_type = "ADT"`. * `send_date` or `sendDate`, the YYYY-MM-DD date the message was sent in the dataset''s time_zone, from the MSH-7 segment. For example, `send_date < "2017-01-02"`. * `send_time`, the timestamp when the message was sent, using the RFC3339 time format for comparisons, from the MSH-7 segment. For example, `send_time < "2017-01-02T00:00:00-05:00"`. * `create_time`, the timestamp when the message was created in the HL7v2 store. Use the RFC3339 time format for comparisons. For example, `create_time < "2017-01-02T00:00:00-05:00"`. * `send_facility`, the care center that the message came from, from the MSH-4 segment. For example, `send_facility = "ABC"`. * `PatientId(value, type)`, which matches if the message lists a patient having an ID of the given value and type in the PID-2, PID-3, or PID-4 segments. For example, `PatientId("123456", "MRN")`. * `labels.x`, a string value of the label with key `x` as set using the Message.labels map. For example, `labels."priority"="high"`. The operator `:*` can be used to assert the existence of a label. For example, `labels."priority":*`.' type: string pubsubTopic: description: 'The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. The notification is a `PubsubMessage` with the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It''s guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time when the message was published. Note that notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. The Cloud Healthcare API service account, service-PROJECT_NUMBER@gcp-sa-healthcare.iam.gserviceaccount.com, must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail. If a notification cannot be published to Pub/Sub, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)).' type: string type: object AccessDeterminationLogConfig: description: Configures consent audit log config for FHIR create, read, update, and delete (CRUD) operations. Cloud audit log for healthcare API must be [enabled](https://cloud.google.com/logging/docs/audit/configure-data-access#config-console-enable). The consent-related logs are included as part of `protoPayload.metadata`. properties: logLevel: description: Optional. Controls the amount of detail to include as part of the audit logs. enum: - LOG_LEVEL_UNSPECIFIED - DISABLED - MINIMUM - VERBOSE type: string type: object TimePartitioning: description: Configuration for FHIR BigQuery time-partitioned tables. properties: expirationMs: description: Number of milliseconds for which to keep the storage for a partition. format: int64 type: string type: description: Type of partitioning. enum: - PARTITION_TYPE_UNSPECIFIED - HOUR - DAY - MONTH - YEAR type: string type: object FhirStore_2: description: Represents a FHIR store. properties: complexDataTypeReferenceParsing: description: 'Enable parsing of references within complex FHIR data types such as Extensions. If this value is set to ENABLED, then features like referential integrity and Bundle reference rewriting apply to all references. If this flag has not been specified the behavior of the FHIR store will not change, references in complex data types will not be parsed. New stores will have this value set to ENABLED after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources.' enum: - COMPLEX_DATA_TYPE_REFERENCE_PARSING_UNSPECIFIED - DISABLED - ENABLED type: string consentConfig: $ref: '#/components/schemas/ConsentConfig' description: Optional. Specifies whether this store has consent enforcement. Not available for DSTU2 FHIR version due to absence of Consent resources. defaultSearchHandlingStrict: description: 'If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`.' type: boolean disableReferentialIntegrity: description: Immutable. Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store creation. The default value is false, meaning that the API enforces referential integrity and fails the requests that result in inconsistent state in the FHIR store. When this field is set to true, the API skips referential integrity checks. Consequently, operations that rely on references, such as GetPatientEverything, do not return all the results if broken references exist. type: boolean disableResourceVersioning: description: Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, which is the default behavior, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. type: boolean enableHistoryModifications: description: Optional. Whether to allow ExecuteBundle to accept history bundles, and directly insert and overwrite historical resource versions into the FHIR store. If set to false, using history bundles fails with an error. type: boolean enableUpdateCreate: description: Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. type: boolean labels: additionalProperties: type: string description: 'User-supplied key-value pairs used to organize FHIR stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store.' type: object name: description: Output only. Identifier. Resource name of the FHIR store, of the form `projects/{project_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. type: string notificationConfig: $ref: '#/components/schemas/NotificationConfig' deprecated: true description: Deprecated. Use `notification_configs` instead. If non-empty, publish all resource modifications of this FHIR store to this destination. The Pub/Sub message attributes contain a map with a string describing the action that has triggered the notification. For example, "action":"CreateResource". notificationConfigs: description: Specifies where and whether to send notifications upon changes to a Fhir store. items: $ref: '#/components/schemas/FhirNotificationConfig_2' type: array searchConfig: $ref: '#/components/schemas/SearchConfig' description: Configuration for how FHIR resources can be searched. streamConfigs: description: A list of streaming configs that configure the destinations of streaming export for every resource mutation in this FHIR store. Each store is allowed to have up to 10 streaming configs. After a new config is added, the next resource mutation is streamed to the new location in addition to the existing ones. When a location is removed from the list, the server stops streaming to that location. Before adding a new config, you must add the required [`bigquery.dataEditor`](https://cloud.google.com/bigquery/docs/access-control#bigquery.dataEditor) role to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/iam/docs/service-accounts). Some lag (typically on the order of dozens of seconds) is expected before the results show up in the streaming destination. items: $ref: '#/components/schemas/StreamConfig_2' type: array validationConfig: $ref: '#/components/schemas/ValidationConfig_2' description: Configuration for how to validate incoming FHIR resources against configured profiles. version: description: Required. Immutable. The FHIR specification version that this FHIR store supports natively. This field is immutable after store creation. Requests are rejected if they contain FHIR resources of a different version. Version is required for every FHIR store. enum: - VERSION_UNSPECIFIED - DSTU2 - STU3 - R4 type: string type: object Attribute: description: An attribute value for a Consent or User data mapping. Each Attribute must have a corresponding AttributeDefinition in the consent store that defines the default and allowed values. properties: attributeDefinitionId: description: Indicates the name of an attribute defined in the consent store. type: string values: description: Required. The value of the attribute. Must be an acceptable value as defined in the consent store. For example, if the consent store defines "data type" with acceptable values "questionnaire" and "step-count", when the attribute name is data type, this field must contain one of those values. items: type: string type: array type: object ExplainDataAccessResponse: description: List of consent scopes that are applicable to the explained access on a given resource. properties: consentScopes: description: List of applicable consent scopes. Sorted in order of actor such that scopes belonging to the same actor will be adjacent to each other in the list. items: $ref: '#/components/schemas/ExplainDataAccessConsentScope' type: array warning: description: Warnings associated with this response. It inform user with exceeded scope limit errors. type: string type: object StreamConfig: description: Contains configuration for streaming FHIR export. properties: bigqueryDestination: $ref: '#/components/schemas/GoogleCloudHealthcareV1FhirBigQueryDestination' description: The destination BigQuery structure that contains both the dataset location and corresponding schema config. The output is organized in one table per resource type. The server reuses the existing tables (if any) that are named after the resource types. For example, "Patient", "Observation". When there is no existing table for a given resource type, the server attempts to create one. When a table schema doesn't align with the schema config, either because of existing incompatible schema or out of band incompatible modification, the server does not stream in new data. BigQuery imposes a 1 MB limit on streaming insert row size, therefore any resource mutation that generates more than 1 MB of BigQuery data is not streamed. One resolution in this case is to delete the incompatible table and let the server recreate one, though the newly created table only contains data after the table recreation. Results are written to BigQuery tables according to the parameters in BigQueryDestination.WriteDisposition. Different versions of the same resource are distinguishable by the meta.versionId and meta.lastUpdated columns. The operation (CREATE/UPDATE/DELETE) that results in the new version is recorded in the meta.tag. The tables contain all historical resource versions since streaming was enabled. For query convenience, the server also creates one view per table of the same name containing only the current resource version. The streamed data in the BigQuery dataset is not guaranteed to be completely unique. The combination of the id and meta.versionId columns should ideally identify a single unique row. But in rare cases, duplicates may exist. At query time, users may use the SQL select statement to keep only one of the duplicate rows given an id and meta.versionId pair. Alternatively, the server created view mentioned above also filters out duplicates. If a resource mutation cannot be streamed to BigQuery, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). deidentifiedStoreDestination: $ref: '#/components/schemas/DeidentifiedStoreDestination' description: The destination FHIR store for de-identified resources. After this field is added, all subsequent creates/updates/patches to the source store will be de-identified using the provided configuration and applied to the destination store. Importing resources to the source store will not trigger the streaming. If the source store already contains resources when this option is enabled, those resources will not be copied to the destination store unless they are subsequently updated. This may result in invalid references in the destination store. Before adding this config, you must grant the healthcare.fhirResources.update permission on the destination store to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/healthcare/docs/how-tos/permissions-healthcare-api-gcp-products#the_cloud_healthcare_service_agent). The destination store must set enable_update_create to true. The destination store must have disable_referential_integrity set to true. If a resource cannot be de-identified, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). resourceTypes: description: Supply a FHIR resource type (such as "Patient" or "Observation"). See https://www.hl7.org/fhir/valueset-resource-types.html for a list of all FHIR resource types. The server treats an empty list as an intent to stream all the supported resource types in this FHIR store. items: type: string type: array type: object Hl7V2StoreMetrics: description: List of metrics for a given HL7v2 store. properties: metrics: description: List of HL7v2 store metrics by message type. items: $ref: '#/components/schemas/Hl7V2StoreMetric' type: array name: description: The resource name of the HL7v2 store to get metrics for, in the format `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`. type: string type: object Annotation: description: An annotation record. properties: annotationSource: $ref: '#/components/schemas/AnnotationSource' description: Required. Details of the source. customData: additionalProperties: type: string description: Additional information for this annotation record, such as annotator and verifier information or study campaign. type: object imageAnnotation: $ref: '#/components/schemas/ImageAnnotation' description: Annotations for images. For example, bounding polygons. name: description: Identifier. Resource name of the Annotation, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}/annotations/{annotation_id}`. type: string resourceAnnotation: $ref: '#/components/schemas/ResourceAnnotation' description: Annotations for resource. For example, classification tags. textAnnotation: $ref: '#/components/schemas/SensitiveTextAnnotation' description: Annotations for sensitive texts. For example, a range that describes the location of sensitive text. type: object DicomFilterConfig: description: Specifies the filter configuration for DICOM resources. properties: resourcePathsGcsUri: description: The Cloud Storage location of the filter configuration file. The `gcs_uri` must be in the format `gs://bucket/path/to/object`. The filter configuration file must contain a list of resource paths separated by newline characters (\n or \r\n). Each resource path must be in the format "/studies/{studyUID}[/series/{seriesUID}[/instances/{instanceUID}]]" The Cloud Healthcare API service account must have the `roles/storage.objectViewer` Cloud IAM role for this Cloud Storage location. type: string type: object ParserConfig: description: The configuration for the parser. It determines how the server parses the messages. properties: allowNullHeader: description: Determines whether messages with no header are allowed. type: boolean schema: $ref: '#/components/schemas/SchemaPackage' description: Schemas used to parse messages in this store, if schematized parsing is desired. segmentTerminator: description: Byte(s) to use as the segment terminator. If this is unset, '\r' is used as segment terminator, matching the HL7 version 2 specification. format: byte type: string version: description: Immutable. Determines the version of both the default parser to be used when `schema` is not given, as well as the schematized parser used when `schema` is specified. This field is immutable after HL7v2 store creation. enum: - PARSER_VERSION_UNSPECIFIED - V1 - V2 - V3 type: string type: object ExplainDataAccessConsentInfo: description: The enforcing consent's metadata. properties: cascadeOrigins: description: 'The compartment base resources that matched a cascading policy. Each resource has the following format: `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/{resource_type}/{resource_id}`' items: type: string type: array consentResource: description: 'The resource name of this consent resource. Format: `projects/{projectId}/datasets/{datasetId}/fhirStores/{fhirStoreId}/fhir/{resourceType}/{id}`.' type: string enforcementTime: description: Last enforcement timestamp of this consent resource. format: google-datetime type: string matchingAccessorScopes: description: A list of all the matching accessor scopes of this consent policy that enforced ExplainDataAccessConsentScope.accessor_scope. items: $ref: '#/components/schemas/ConsentAccessorScope' type: array patientConsentOwner: description: 'The patient owning the consent (only applicable for patient consents), in the format: `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Patient/{patient_id}`' type: string type: description: The policy type of consent resource (e.g. PATIENT, ADMIN). enum: - CONSENT_POLICY_TYPE_UNSPECIFIED - CONSENT_POLICY_TYPE_PATIENT - CONSENT_POLICY_TYPE_ADMIN type: string variants: description: The consent's variant combinations. A single consent may have multiple variants. items: enum: - VARIANT_UNSPECIFIED - VARIANT_STANDARD - VARIANT_CASCADE type: string type: array type: object ExplainDataAccessConsentScope: description: A single consent scope that provides info on who has access to the requested resource scope for a particular purpose and environment, enforced by which consent. properties: accessorScope: $ref: '#/components/schemas/ConsentAccessorScope' description: The accessor scope that describes who can access, for what purpose, and in which environment. decision: description: Whether the current consent scope is permitted or denied access on the requested resource. enum: - CONSENT_DECISION_TYPE_UNSPECIFIED - CONSENT_DECISION_TYPE_PERMIT - CONSENT_DECISION_TYPE_DENY type: string enforcingConsents: description: Metadata of the consent resources that enforce the consent scope's access. items: $ref: '#/components/schemas/ExplainDataAccessConsentInfo' type: array exceptions: description: Other consent scopes that created exceptions within this scope. items: $ref: '#/components/schemas/ExplainDataAccessConsentScope' type: array type: object VersionSource: description: Describes a selector for extracting and matching an MSH field to a value. properties: mshField: description: The field to extract from the MSH segment. For example, "3.1" or "18[1].1". type: string value: description: The value to match with the field. For example, "My Application Name" or "2.3". type: string type: object UserDataMapping: description: Maps a resource to the associated user and Attributes. properties: archiveTime: description: Output only. Indicates the time when this mapping was archived. format: google-datetime readOnly: true type: string archived: description: Output only. Indicates whether this mapping is archived. readOnly: true type: boolean dataId: description: Required. A unique identifier for the mapped resource. type: string name: description: Resource name of the User data mapping, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/userDataMappings/{user_data_mapping_id}`. type: string resourceAttributes: description: Attributes of the resource. Only explicitly set attributes are displayed here. Attribute definitions with defaults set implicitly apply to these User data mappings. Attributes listed here must be single valued, that is, exactly one value is specified for the field "values" in each Attribute. items: $ref: '#/components/schemas/Attribute' type: array userId: description: Required. User's UUID provided by the client. type: string type: object ConsentEvaluation: description: The detailed evaluation of a particular Consent. properties: evaluationResult: description: The evaluation result. enum: - EVALUATION_RESULT_UNSPECIFIED - NOT_APPLICABLE - NO_MATCHING_POLICY - NO_SATISFIED_POLICY - HAS_SATISFIED_POLICY type: string type: object FieldMetadata: description: Specifies FHIR paths to match, and how to handle de-identification of matching fields. properties: action: description: Deidentify action for one field. enum: - ACTION_UNSPECIFIED - TRANSFORM - INSPECT_AND_TRANSFORM - DO_NOT_TRANSFORM type: string paths: description: 'List of paths to FHIR fields to be redacted. Each path is a period-separated list where each component is either a field name or FHIR type name, for example: Patient, HumanName. For "choice" types (those defined in the FHIR spec with the form: field[x]) we use two separate components. For example, "deceasedAge.unit" is matched by "Deceased.Age.unit". Supported types are: AdministrativeGenderCode, Base64Binary, Boolean, Code, Date, DateTime, Decimal, HumanName, Id, Instant, Integer, LanguageCode, Markdown, Oid, PositiveInt, String, UnsignedInt, Uri, Uuid, Xhtml.' items: type: string type: array type: object InfoTypeTransformation: description: A transformation to apply to text that is identified as a specific info_type. properties: characterMaskConfig: $ref: '#/components/schemas/CharacterMaskConfig' description: Config for character mask. cryptoHashConfig: $ref: '#/components/schemas/CryptoHashConfig' description: Config for crypto hash. dateShiftConfig: $ref: '#/components/schemas/DateShiftConfig' description: Config for date shift. infoTypes: description: InfoTypes to apply this transformation to. If this is not specified, the transformation applies to any info_type. items: type: string type: array redactConfig: $ref: '#/components/schemas/RedactConfig' description: Config for text redaction. replaceWithInfoTypeConfig: $ref: '#/components/schemas/ReplaceWithInfoTypeConfig' description: Config for replace with InfoType. type: object Message: description: A complete HL7v2 message. See [Introduction to HL7 Standards] (https://www.hl7.org/implement/standards/index.cfm?ref=common) for details on the standard. properties: createTime: description: Output only. The datetime when the message was created. Set by the server. format: google-datetime readOnly: true type: string data: description: Required. Raw message bytes. format: byte type: string labels: additionalProperties: type: string description: 'User-supplied key-value pairs used to organize HL7v2 stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store.' type: object messageType: description: The message type for this message. MSH-9.1. type: string name: 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. readOnly: true type: string parsedData: $ref: '#/components/schemas/ParsedData' description: Output only. The parsed version of the raw message data. readOnly: true patientIds: description: All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message. items: $ref: '#/components/schemas/PatientId' type: array schematizedData: $ref: '#/components/schemas/SchematizedData' description: The parsed version of the raw message data schematized according to this store's schemas and type definitions. sendFacility: description: The hospital that this message came from. MSH-4. type: string sendTime: description: The datetime the sending application sent this message. MSH-7. format: google-datetime type: string type: object TestIamPermissionsResponse: description: Response message for `TestIamPermissions` method. properties: permissions: description: A subset of `TestPermissionsRequest.permissions` that the caller is allowed. items: type: string type: array type: object SetIamPolicyRequest: description: Request message for `SetIamPolicy` method. properties: policy: $ref: '#/components/schemas/Policy' description: 'REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.' updateMask: description: 'OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"`' format: google-fieldmask type: string type: object ListAttributeDefinitionsResponse: properties: attributeDefinitions: description: The returned Attribute definitions. The maximum number of attributes returned is determined by the value of page_size in the ListAttributeDefinitionsRequest. items: $ref: '#/components/schemas/AttributeDefinition' type: array nextPageToken: description: Token to retrieve the next page of results, or empty if there are no more results in the list. type: string type: object AnalyzeEntitiesResponse: description: Includes recognized entity mentions and relationships between them. properties: entities: description: The union of all the candidate entities that the entity_mentions in this response could link to. These are UMLS concepts or normalized mention content. items: $ref: '#/components/schemas/Entity' type: array entityMentions: description: The `entity_mentions` field contains all the annotated medical entities that were mentioned in the provided document. items: $ref: '#/components/schemas/EntityMention' type: array fhirBundle: description: The FHIR bundle ([`R4`](http://hl7.org/fhir/R4/bundle.html)) that includes all the entities, the entity mentions, and the relationships in JSON format. type: string relationships: description: relationships contains all the binary relationships that were identified between entity mentions within the provided document. items: $ref: '#/components/schemas/EntityMentionRelationship' type: array type: object Hl7TypesConfig: description: Root config for HL7v2 datatype definitions for a specific HL7v2 version. properties: type: description: The HL7v2 type definitions. items: $ref: '#/components/schemas/Type' type: array version: description: The version selectors that this config applies to. A message must match ALL version sources to apply. items: $ref: '#/components/schemas/VersionSource' type: array type: object GoogleCloudHealthcareV1beta1DicomBigQueryDestination: description: The BigQuery table where the server writes output. properties: force: description: Use `write_disposition` instead. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. type: boolean tableUri: description: BigQuery URI to a table, up to 2000 characters long, in the format `bq://projectId.bqDatasetId.tableId` type: string writeDisposition: description: Determines whether the existing table in the destination is to be overwritten or appended to. If a write_disposition is specified, the `force` parameter is ignored. enum: - WRITE_DISPOSITION_UNSPECIFIED - WRITE_EMPTY - WRITE_TRUNCATE - WRITE_APPEND type: string type: object Resources: description: A list of FHIR resources. properties: resources: description: List of resources IDs. For example, "Patient/1234". items: type: string type: array type: object CheckDataAccessResponse: description: Checks if a particular data_id of a User data mapping in the given consent store is consented for a given use. properties: consentDetails: additionalProperties: $ref: '#/components/schemas/ConsentEvaluation' description: The resource names of all evaluated Consents mapped to their evaluation. type: object consented: description: Whether the requested resource is consented for the given use. type: boolean type: object ArchiveUserDataMappingRequest: description: Archives the specified User data mapping. properties: {} type: object EvaluateUserConsentsResponse: properties: nextPageToken: description: Token to retrieve the next page of results, or empty if there are no more results in the list. This token is valid for 72 hours after it is created. type: string results: description: The consent evaluation result for each `data_id`. items: $ref: '#/components/schemas/Result' type: array type: object ParsedData: description: The content of a HL7v2 message in a structured format. properties: segments: items: $ref: '#/components/schemas/Segment' type: array type: object ConsentList: description: List of resource names of Consent resources. properties: consents: description: The resource names of the Consents to evaluate against, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}`. items: type: string type: array type: object PatientId: description: A patient identifier and associated type. properties: type: description: ID type. For example, MRN or NHS. type: string value: description: The patient's unique identifier. type: string type: object AnnotationStore: description: An Annotation store that can store annotation resources such as labels and tags for text, image and audio. properties: labels: additionalProperties: type: string description: 'Optional. User-supplied key-value pairs used to organize Annotation stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store.' type: object name: description: Identifier. Resource name of the Annotation store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}`. type: string type: object Feature: description: A feature of an entity mention. properties: confidence: description: The model's confidence in this feature annotation. A number between 0 and 1. format: double type: number value: description: The value of this feature annotation. Its range depends on the type of the feature. type: string type: object Entity: description: The candidate entities that an entity mention could link to. properties: entityId: description: entity_id is a first class field entity_id uniquely identifies this concept and its meta-vocabulary. For example, "UMLS/C0000970". type: string preferredTerm: description: preferred_term is the preferred term for this concept. For example, "Acetaminophen". For ad hoc entities formed by normalization, this is the most popular unnormalized string. type: string vocabularyCodes: description: Vocabulary codes are first-class fields and differentiated from the concept unique identifier (entity_id). vocabulary_codes contains the representation of this concept in particular vocabularies, such as ICD-10, SNOMED-CT and RxNORM. These are prefixed by the name of the vocabulary, followed by the unique code within that vocabulary. For example, "RXNORM/A10334543". items: type: string type: array type: object KmsWrappedCryptoKey: description: Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. The key must grant the Cloud IAM permission `cloudkms.cryptoKeyVersions.useToDecrypt` to the project's Cloud Healthcare Service Agent service account. For more information, see [Creating a wrapped key] (https://cloud.google.com/dlp/docs/create-wrapped-key). properties: cryptoKey: description: Required. The resource name of the KMS CryptoKey to use for unwrapping. For example, `projects/{project_id}/locations/{location_id}/keyRings/{keyring}/cryptoKeys/{key}`. type: string wrappedKey: description: Required. The wrapped data crypto key. format: byte type: string type: object BlobStorageInfo: description: 'BlobStorageInfo contains details about the data stored in Blob Storage for the referenced resource. Note: Storage class is only valid for DICOM and hence will only be populated for DICOM resources.' properties: sizeBytes: description: Size in bytes of data stored in Blob Storage. format: int64 type: string storageClass: description: The storage class in which the Blob data is stored. enum: - BLOB_STORAGE_CLASS_UNSPECIFIED - STANDARD - NEARLINE - COLDLINE - ARCHIVE type: string storageClassUpdateTime: description: The time at which the storage class was updated. This is used to compute early deletion fees of the resource. format: google-datetime type: string type: object DeidentifyConfig: description: Configures de-id options specific to different types of content. Each submessage customizes the handling of an https://tools.ietf.org/html/rfc6838 media type or subtype. Configs are applied in a nested manner at runtime. properties: dicom: $ref: '#/components/schemas/DicomConfig' description: Configures de-id of application/DICOM content. fhir: $ref: '#/components/schemas/FhirConfig' description: Configures de-id of application/FHIR content. image: $ref: '#/components/schemas/ImageConfig' description: Configures de-identification of image pixels wherever they are found in the source_dataset. text: $ref: '#/components/schemas/TextConfig' description: Configures de-identification of text wherever it is found in the source_dataset. useRegionalDataProcessing: description: Ensures in-flight data remains in the region of origin during de-identification. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. type: boolean type: object AnnotationSource: description: AnnotationSource holds the source information of the annotation. properties: cloudHealthcareSource: $ref: '#/components/schemas/CloudHealthcareSource' description: Cloud Healthcare API resource. type: object GroupOrSegment: description: Construct representing a logical group or a segment. properties: group: $ref: '#/components/schemas/SchemaGroup' segment: $ref: '#/components/schemas/SchemaSegment' type: object IngestMessageResponse: description: Acknowledges that a message has been ingested into the specified HL7v2 store. properties: hl7Ack: description: HL7v2 ACK message. format: byte type: string message: $ref: '#/components/schemas/Message' description: Created message resource. type: object GoogleCloudHealthcareV1ConsentGcsDestination: description: The Cloud Storage location for export. properties: uriPrefix: description: URI for a Cloud Storage directory where the server writes result files, in the format `gs://{bucket-id}/{path/to/destination/dir}`. If there is no trailing slash, the service appends one when composing the object path. The user is responsible for creating the Cloud Storage bucket and directory referenced in `uri_prefix`. type: string type: object PatientScope: description: Apply consents given by a list of patients. properties: patientIds: description: Optional. The list of patient IDs whose Consent resources will be enforced. At most 10,000 patients can be specified. An empty list is equivalent to all patients (meaning the entire FHIR store). items: type: string type: array type: object QueryAccessibleDataRequest_2: description: Queries all data_ids that are consented for a given use in the given consent store and writes them to a specified destination. The returned Operation includes a progress counter for the number of User data mappings processed. Errors are logged to Cloud Logging (see [Viewing error logs in Cloud Logging] (https://cloud.google.com/healthcare/docs/how-tos/logging) and [QueryAccessibleData] for a sample log entry). properties: gcsDestination: $ref: '#/components/schemas/GoogleCloudHealthcareV1beta1ConsentGcsDestination' description: 'The Cloud Storage destination. The Cloud Healthcare API service account must have the `roles/storage.objectAdmin` Cloud IAM role for this Cloud Storage location. The object name is in the following format: query-accessible-data-result-{operation_id}.txt where each line contains a single data_id.' requestAttributes: additionalProperties: type: string description: The values of request attributes associated with this access request. type: object resourceAttributes: additionalProperties: type: string description: Optional. The values of resource attributes associated with the type of resources being requested. If no values are specified, then all resource types are included in the output. type: object type: object SeriesMetrics: description: SeriesMetrics contains metrics describing a DICOM series. properties: blobStorageSizeBytes: description: Total blob storage bytes for all instances in the series. format: int64 type: string instanceCount: description: Number of instances in the series. format: int64 type: string series: description: 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}`. type: string structuredStorageSizeBytes: description: Total structured storage bytes for all instances in the series. format: int64 type: string type: object ConsentArtifact: description: Documentation of a user's consent. properties: consentContentScreenshots: description: Optional. Screenshots, PDFs, or other binary information documenting the user's consent. items: $ref: '#/components/schemas/Image' type: array consentContentVersion: description: Optional. An string indicating the version of the consent information shown to the user. type: string guardianSignature: $ref: '#/components/schemas/Signature' description: Optional. A signature from a guardian. metadata: additionalProperties: type: string description: Optional. Metadata associated with the Consent artifact. For example, the consent locale or user agent version. type: object name: description: Identifier. Resource name of the Consent artifact, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consentArtifacts/{consent_artifact_id}`. Cannot be changed after creation. type: string userId: description: Required. User's UUID provided by the client. type: string userSignature: $ref: '#/components/schemas/Signature' description: Optional. User's signature. witnessSignature: $ref: '#/components/schemas/Signature' description: Optional. A signature from a witness. type: object GcsSource: description: Specifies the configuration for importing data from Cloud Storage. properties: uri: description: 'Points to a Cloud Storage URI containing file(s) to import. The URI must be in the following format: `gs://{bucket_id}/{object_id}`. The URI can include wildcards in `object_id` and thus identify multiple files. Supported wildcards: * `*` to match 0 or more non-separator characters * `**` to match 0 or more characters (including separators). Must be used at the end of a path and with no other wildcards in the path. Can also be used with a file extension (such as .ndjson), which imports all files with the extension in the specified directory and its sub-directories. For example, `gs://my-bucket/my-directory/**.ndjson` imports all files with `.ndjson` extensions in `my-directory/` and its sub-directories. * `?` to match 1 character Files matching the wildcard are expected to contain content only, no metadata.' type: string type: object SchemaConfig_2: description: Configuration for the FHIR BigQuery schema. Determines how the server generates the schema. properties: lastUpdatedPartitionConfig: $ref: '#/components/schemas/TimePartitioning' description: The configuration for exported BigQuery tables to be partitioned by FHIR resource's last updated time column. recursiveStructureDepth: description: The depth for all recursive structures in the output analytics schema. For example, `concept` in the CodeSystem resource is a recursive structure; when the depth is 2, the CodeSystem table will have a column called `concept.concept` but not `concept.concept.concept`. If not specified or set to 0, the server will use the default value 2. The maximum depth allowed is 5. format: int64 type: string schemaType: description: Specifies the output schema type. Schema type is required. enum: - SCHEMA_TYPE_UNSPECIFIED - LOSSLESS - ANALYTICS - ANALYTICS_V2 type: string type: object RevokeConsentRequest: description: Revokes the latest revision of the specified Consent by committing a new revision with `state` updated to `REVOKED`. If the latest revision of the given Consent is in the `REVOKED` state, no new revision is committed. properties: consentArtifact: description: Optional. The resource name of the Consent artifact that contains proof of the user's revocation of the Consent, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consentArtifacts/{consent_artifact_id}`. type: string type: object DeidentifyFhirStoreRequest: description: Creates a new FHIR store with sensitive information de-identified. properties: config: $ref: '#/components/schemas/DeidentifyConfig' description: Deidentify configuration. Only one of `config` and `gcs_config_uri` can be specified. destinationStore: description: Required. The name of the FHIR store to create and write the redacted data to. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. * The destination dataset must exist. * The source dataset and destination dataset must both reside in the same location. De-identifying data across multiple locations is not supported. * The destination FHIR store must exist. * The caller must have the healthcare.fhirResources.update permission to write to the destination FHIR store. type: string gcsConfigUri: description: Cloud Storage location to read the JSON cloud.healthcare.deidentify.DeidentifyConfig from, overriding the default config. Must be of the form `gs://{bucket_id}/path/to/object`. The Cloud Storage location must grant the Cloud IAM role `roles/storage.objectViewer` to the project's Cloud Healthcare Service Agent service account. Only one of `config` and `gcs_config_uri` can be specified. type: string resourceFilter: $ref: '#/components/schemas/FhirFilter' description: A filter specifying the resources to include in the output. If not specified, all resources are included in the output. skipModifiedResources: description: If true, skips resources that are created or modified after the de-identify operation is created. type: boolean type: object SearchResourcesRequest_2: description: Request to search the resources in the specified FHIR store. properties: resourceType: 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)). type: string type: object HttpBody: description: 'Message that represents an arbitrary HTTP body. It should only be used for payload formats that can''t be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.' properties: contentType: description: The HTTP Content-Type header value specifying the content type of the body. type: string data: description: The HTTP request/response body as raw binary. format: byte type: string extensions: description: Application specific response metadata. Must be set in the first response for streaming APIs. items: additionalProperties: description: Properties of the object. Contains field @type with type URL. type: object type: array type: object GoogleCloudHealthcareV1beta1ConsentGcsDestination: description: The Cloud Storage location for export. properties: uriPrefix: description: URI for a Cloud Storage directory where the server writes result files, in the format `gs://{bucket-id}/{path/to/destination/dir}`. If there is no trailing slash, the service appends one when composing the object path. The user is responsible for creating the Cloud Storage bucket and directory referenced in `uri_prefix`. type: string type: object ListHl7V2StoresResponse: description: Lists the HL7v2 stores in the given dataset. properties: hl7V2Stores: description: The returned HL7v2 stores. Won't be more HL7v2 stores than the value of page_size in the request. items: $ref: '#/components/schemas/Hl7V2Store' type: array nextPageToken: description: Token to retrieve the next page of results or empty if there are no more results in the list. type: string type: object StorageInfo: description: StorageInfo encapsulates all the storage info of a resource. properties: blobStorageInfo: $ref: '#/components/schemas/BlobStorageInfo' description: Info about the data stored in blob storage for the resource. referencedResource: description: 'The resource whose storage info is returned. For example, to specify the resource path of a DICOM Instance: `projects/{projectid}/datasets/{datasetid}/dicomStores/{dicom_store_id}/dicomWeb/studi/{study_uid}/series/{series_uid}/instances/{instance_uid}`' type: string structuredStorageInfo: $ref: '#/components/schemas/StructuredStorageInfo' description: Info about the data stored in structured storage for the resource. type: object Detail: description: Contains multiple sensitive information findings for each resource slice. properties: findings: items: $ref: '#/components/schemas/Finding' type: array type: object RollbackFhirResourceFilteringFields_2: description: Filters to select resources that need to be rolled back. properties: metadataFilter: description: 'Optional. A filter expression that matches data in the `Resource.meta` element. Supports all filters in [AIP-160](https://google.aip.dev/160) except the "has" (`:`) operator. Supports the following custom functions: * `tag("") = ""` for tag filtering. * `extension_value_ts("") = ` for filtering extensions with a timestamp, where `` is a Unix timestamp. Supports the `>`, `<`, `<=`, `>=`, and `!=` comparison operators.' type: string operationIds: description: Optional. A list of operation IDs to roll back. Only changes made by these operations will be rolled back. items: format: uint64 type: string type: array type: object DicomConfig: description: Specifies the parameters needed for de-identification of DICOM stores. properties: filterProfile: description: Tag filtering profile that determines which tags to keep/remove. enum: - TAG_FILTER_PROFILE_UNSPECIFIED - MINIMAL_KEEP_LIST_PROFILE - ATTRIBUTE_CONFIDENTIALITY_BASIC_PROFILE - KEEP_ALL_PROFILE - DEIDENTIFY_TAG_CONTENTS type: string keepList: $ref: '#/components/schemas/TagFilterList' description: List of tags to keep. Remove all other tags. removeList: $ref: '#/components/schemas/TagFilterList' description: List of tags to remove. Keep all other tags. skipIdRedaction: description: 'If true, skip replacing StudyInstanceUID, SeriesInstanceUID, SOPInstanceUID, and MediaStorageSOPInstanceUID and leave them untouched. The Cloud Healthcare API regenerates these UIDs by default based on the DICOM Standard''s reasoning: "Whilst these UIDs cannot be mapped directly to an individual out of context, given access to the original images, or to a database of the original images containing the UIDs, it would be possible to recover the individual''s identity." http://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9.html' type: boolean type: object ListLocationsResponse: description: The response message for Locations.ListLocations. properties: locations: description: A list of locations that matches the specified filter in the request. items: $ref: '#/components/schemas/Location' type: array nextPageToken: description: The standard List next-page token. type: string type: object ConfigureSearchRequest: description: Request to configure the search parameters for the specified FHIR store. properties: canonicalUrls: description: The canonical URLs of the search parameters that are intended to be used for the FHIR store. See https://www.hl7.org/fhir/references.html#canonical for explanation on FHIR canonical urls items: type: string type: array validateOnly: description: If `validate_only` is set to true, the method will compile all the search parameters without actually setting the search config for the store and triggering the reindex. type: boolean type: object ConsentConfig: description: Configures whether to enforce consent for the FHIR store and which consent enforcement version is being used. properties: accessDeterminationLogConfig: $ref: '#/components/schemas/AccessDeterminationLogConfig' description: Optional. Specifies how the server logs the consent-aware requests. If not specified, the `AccessDeterminationLogConfig.LogLevel.MINIMUM` option is used. accessEnforced: description: Optional. If set to true, when accessing FHIR resources, the consent headers will be verified against consents given by patients. See the ConsentEnforcementVersion for the supported consent headers. type: boolean consentHeaderHandling: $ref: '#/components/schemas/ConsentHeaderHandling' description: Optional. Different options to configure the behaviour of the server when handling the `X-Consent-Scope` header. enforcedAdminConsents: description: The versioned names of the enforced admin Consent resource(s), in the format `projects/{project_id}/locations/{location}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Consent/{resource_id}/_history/{version_id}`. For FHIR stores with `disable_resource_versioning=true`, the format is `projects/{project_id}/locations/{location}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Consent/{resource_id}`. This field can only be updated using ApplyAdminConsents. items: type: string type: array version: description: Required. Specifies which consent enforcement version is being used for this FHIR store. This field can only be set once by either CreateFhirStore or UpdateFhirStore. After that, you must call ApplyConsents to change the version. enum: - CONSENT_ENFORCEMENT_VERSION_UNSPECIFIED - V1 type: string type: object ConsentStore_2: description: Represents a consent store. properties: defaultConsentTtl: description: Optional. Default time to live for Consents created in this store. Must be at least 24 hours. Updating this field will not affect the expiration time of existing consents. format: google-duration type: string enableConsentCreateOnUpdate: description: Optional. If `true`, UpdateConsent creates the Consent if it does not already exist. If unspecified, defaults to `false`. type: boolean labels: additionalProperties: type: string description: 'Optional. User-supplied key-value pairs used to organize consent stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62}. Label values must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63}. No more than 64 labels can be associated with a given store. For more information: https://cloud.google.com/healthcare/docs/how-tos/labeling-resources' type: object name: description: Resource name of the consent store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}`. Cannot be changed after creation. type: string type: object RollbackFhirResourcesRequest_2: description: Request to roll back resources. properties: changeType: description: Optional. CREATE/UPDATE/DELETE/ALL for reverting all txns of a certain type. enum: - CHANGE_TYPE_UNSPECIFIED - ALL - CREATE - UPDATE - DELETE type: string excludeRollbacks: description: Optional. Specifies whether to exclude earlier rollbacks. type: boolean filteringFields: $ref: '#/components/schemas/RollbackFhirResourceFilteringFields_2' description: Optional. Tag represents fields that HDE needs to identify resources that will be reverted. Parameters for filtering resources force: description: Optional. When enabled, changes will be reverted without explicit confirmation type: boolean inputGcsObject: description: Optional. Cloud Storage object containing list of {resourceType}/{resourceId} lines, identifying resources to be reverted type: string resultGcsBucket: description: Required. Bucket to deposit result type: string rollbackTime: description: Required. Time point to rollback to. format: google-datetime type: string type: description: Optional. If specified, revert only resources of these types items: type: string type: array type: object AdminConsents: description: List of admin Consent resources to be applied. properties: names: description: The versioned names of the admin Consent resource(s), in the format `projects/{project_id}/locations/{location}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Consent/{resource_id}/_history/{version_id}`. For FHIR stores with `disable_resource_versioning=true`, the format is `projects/{project_id}/locations/{location}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Consent/{resource_id}`. items: type: string type: array type: object CryptoHashConfig: description: Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. Outputs a base64-encoded representation of the hashed output (for example, `L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=`). properties: cryptoKey: description: An AES 128/192/256 bit key. Causes the hash to be computed based on this key. A default key is generated for each Deidentify operation and is used when neither `crypto_key` nor `kms_wrapped` is specified. Must not be set if `kms_wrapped` is set. format: byte type: string kmsWrapped: $ref: '#/components/schemas/KmsWrappedCryptoKey' description: KMS wrapped key. Must not be set if `crypto_key` is set. type: object Policy: description: 'An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp(''2020-10-01T00:00:00.000Z'')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp(''2020-10-01T00:00:00.000Z'') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).' properties: auditConfigs: description: Specifies cloud audit logging configuration for this policy. items: $ref: '#/components/schemas/AuditConfig' type: array bindings: description: Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. items: $ref: '#/components/schemas/Binding' type: array etag: description: '`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.' format: byte type: string version: description: 'Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).' format: int32 type: integer type: object EntityMentionRelationship: description: Defines directed relationship from one entity mention to another. properties: confidence: description: The model's confidence in this annotation. A number between 0 and 1. format: double type: number objectId: description: object_id is the id of the object entity mention. type: string subjectId: description: subject_id is the id of the subject entity mention. type: string type: object ListAnnotationStoresResponse: description: Lists the Annotation stores in the given dataset. properties: annotationStores: description: The returned Annotation stores. Won't be more Annotation stores than the value of page_size in the request. items: $ref: '#/components/schemas/AnnotationStore' type: array nextPageToken: description: Token to retrieve the next page of results or empty if there are no more results in the list. type: string type: object GoogleCloudHealthcareV1beta1ConsentPolicy: description: Represents a user's consent in terms of the resources that can be accessed and under what conditions. properties: authorizationRule: $ref: '#/components/schemas/Expr' description: Required. The request conditions to meet to grant access. In addition to any supported comparison operators, authorization rules may have `IN` operator as well as at most 10 logical operators that are limited to `AND` (`&&`), `OR` (`||`). resourceAttributes: description: The resources that this policy applies to. A resource is a match if it matches all the attributes listed here. If empty, this policy applies to all User data mappings for the given user. items: $ref: '#/components/schemas/Attribute_2' type: array type: object GoogleCloudHealthcareV1beta1AnnotationBigQueryDestination: description: The BigQuery table for export. properties: force: description: Use `write_disposition` instead. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. type: boolean schemaType: description: Specifies the schema format to export. enum: - SCHEMA_TYPE_UNSPECIFIED - SIMPLE type: string tableUri: description: BigQuery URI to a table, up to 2000 characters long, must be of the form bq://projectId.bqDatasetId.tableId. type: string writeDisposition: description: Determines if existing data in the destination dataset is overwritten, appended to, or not written if the tables contain data. If a write_disposition is specified, the `force` parameter is ignored. enum: - WRITE_DISPOSITION_UNSPECIFIED - WRITE_EMPTY - WRITE_TRUNCATE - WRITE_APPEND type: string type: object ListDatasetsResponse: description: Lists the available datasets. properties: datasets: description: The first page of datasets. items: $ref: '#/components/schemas/Dataset' type: array nextPageToken: description: Token to retrieve the next page of results, or empty if there are no more results in the list. type: string type: object ListConsentStoresResponse: properties: consentStores: description: The returned consent stores. The maximum number of stores returned is determined by the value of page_size in the ListConsentStoresRequest. items: $ref: '#/components/schemas/ConsentStore' type: array nextPageToken: description: Token to retrieve the next page of results, or empty if there are no more results in the list. type: string type: object SchematizedData: description: The content of an HL7v2 message in a structured format as specified by a schema. properties: data: description: JSON output of the parser. type: string error: description: The error output of the parser. type: string type: object ImportMessagesRequest: description: Request to import messages. properties: gcsSource: $ref: '#/components/schemas/GcsSource' description: Cloud Storage source data location and import configuration. The Cloud Healthcare Service Agent requires the `roles/storage.objectViewer` Cloud IAM roles on the Cloud Storage location. type: object RollbackFhirResourcesRequest: properties: changeType: description: Optional. CREATE/UPDATE/DELETE/ALL for reverting all txns of a certain type. enum: - CHANGE_TYPE_UNSPECIFIED - ALL - CREATE - UPDATE - DELETE type: string excludeRollbacks: description: Optional. Specifies whether to exclude earlier rollbacks. type: boolean filteringFields: $ref: '#/components/schemas/RollbackFhirResourceFilteringFields' description: Optional. Parameters for filtering resources force: description: Optional. When enabled, changes will be reverted without explicit confirmation type: boolean inputGcsObject: description: Optional. GCS object containing list of {resourceType}/{resourceId} lines, identifying resources to be reverted type: string resultGcsBucket: description: Required. Bucket to deposit result type: string rollbackTime: description: Required. Time point to rollback to. format: google-datetime type: string type: description: Optional. If specified, revert only resources of these types items: type: string type: array type: object BoundingPoly: description: A bounding polygon for the detected image annotation. properties: label: description: A description of this polygon. type: string vertices: description: List of the vertices of this polygon. items: $ref: '#/components/schemas/Vertex' type: array type: object Field: description: A (sub) field of a type. properties: maxOccurs: description: The maximum number of times this field can be repeated. 0 or -1 means unbounded. format: int32 type: integer minOccurs: description: The minimum number of times this field must be present/repeated. format: int32 type: integer name: description: The name of the field. For example, "PID-1" or just "1". type: string table: description: The HL7v2 table this field refers to. For example, PID-15 (Patient's Primary Language) usually refers to table "0296". type: string type: description: The type of this field. A Type with this name must be defined in an Hl7TypesConfig. type: string type: object TagFilterList: description: List of tags to be filtered. properties: tags: description: 'Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example "PatientID", "00100010".' items: type: string type: array type: object GoogleCloudHealthcareV1beta1FhirBigQueryDestination: description: The configuration for exporting to BigQuery. properties: datasetUri: description: BigQuery URI to an existing dataset, up to 2000 characters long, in the format `bq://projectId.bqDatasetId`. type: string force: description: Use `write_disposition` instead. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. type: boolean schemaConfig: $ref: '#/components/schemas/SchemaConfig_2' description: The configuration for the exported BigQuery schema. writeDisposition: description: Determines if existing data in the destination dataset is overwritten, appended to, or not written if the tables contain data. If a write_disposition is specified, the `force` parameter is ignored. enum: - WRITE_DISPOSITION_UNSPECIFIED - WRITE_EMPTY - WRITE_TRUNCATE - WRITE_APPEND type: string type: object ValidationConfig_2: description: Contains the configuration for FHIR profiles and validation. properties: disableFhirpathValidation: description: Whether to disable FHIRPath validation for incoming resources. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. type: boolean disableProfileValidation: description: Whether to disable profile validation for this FHIR store. Set this to true to disable checking incoming resources for conformance against StructureDefinitions in this FHIR store. type: boolean disableReferenceTypeValidation: description: Whether to disable reference type validation for incoming resources. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. type: boolean disableRequiredFieldValidation: description: Whether to disable required fields validation for incoming resources. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. type: boolean enabledImplementationGuides: description: 'A list of ImplementationGuide URLs in this FHIR store that are used to configure the profiles to use for validation. For example, to use the US Core profiles for validation, set `enabled_implementation_guides` to `["http://hl7.org/fhir/us/core/ImplementationGuide/ig"]`. If `enabled_implementation_guides` is empty or omitted, then incoming resources are only required to conform to the base FHIR profiles. Otherwise, a resource must conform to at least one profile listed in the `global` property of one of the enabled ImplementationGuides. The Cloud Healthcare API does not currently enforce all of the rules in a StructureDefinition. The following rules are supported: - min/max - minValue/maxValue - maxLength - type - fixed[x] - pattern[x] on simple types - slicing, when using "value" as the discriminator type When a URL cannot be resolved (for example, in a type assertion), the server does not return an error.' items: type: string type: array type: object ConsentHeaderHandling: description: How the server handles the consent header. properties: profile: description: Optional. Specifies the default server behavior when the header is empty. If not specified, the `ScopeProfile.PERMIT_EMPTY_SCOPE` option is used. enum: - SCOPE_PROFILE_UNSPECIFIED - PERMIT_EMPTY_SCOPE - REQUIRED_ON_READ type: string type: object FhirConfig: description: Specifies how to handle de-identification of a FHIR store. properties: defaultKeepExtensions: description: The behaviour for handling FHIR extensions that aren't otherwise specified for de-identification. If true, all extensions are preserved during de-identification by default. If false or unspecified, all extensions are removed during de-identification by default. type: boolean fieldMetadataList: description: Specifies FHIR paths to match and how to transform them. Any field that is not matched by a FieldMetadata is passed through to the output dataset unmodified. All extensions will be processed according to `default_keep_extensions`. items: $ref: '#/components/schemas/FieldMetadata' type: array type: object RedactConfig: description: Define how to redact sensitive values. Default behaviour is erase. For example, "My name is Jane." becomes "My name is ." properties: {} type: object Operation: description: This resource represents a long-running operation that is the result of a network API call. properties: done: description: If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. type: boolean error: $ref: '#/components/schemas/Status' description: The error result of the operation in case of failure or cancellation. metadata: additionalProperties: description: Properties of the object. Contains field @type with type URL. description: Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. type: object name: description: The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. type: string response: additionalProperties: description: Properties of the object. Contains field @type with type URL. description: The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. type: object type: object ExportMessagesRequest_2: description: Request to schedule an export. properties: endTime: description: The end of the range in `send_time` (MSH.7, https://www.hl7.org/documentcenter/public_temp_2E58C1F9-1C23-BA17-0C6126475344DA9D/wg/conf/HL7MSH.htm) to process. If not specified, the time when the export is scheduled is used. This value has to come after the `start_time` defined below. Only messages whose `send_time` lies in the range `start_time` (inclusive) to `end_time` (exclusive) are exported. format: google-datetime type: string filter: description: 'Restricts messages exported to those matching a filter, only applicable to PubsubDestination. The following syntax is available: * A string field value can be written as text inside quotation marks, for example `"query text"`. The only valid relational operation for text fields is equality (`=`), where text is searched within the field, rather than having the field be equal to the text. For example, `"Comment = great"` returns messages with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in the `yyyy-mm-dd` format. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, and is just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. The following fields and functions are available for filtering: * `message_type`, from the MSH-9.1 field. For example, `NOT message_type = "ADT"`. * `send_date` or `sendDate`, the YYYY-MM-DD date the message was sent in the dataset''s time_zone, from the MSH-7 segment. For example, `send_date < "2017-01-02"`. * `send_time`, the timestamp when the message was sent, using the RFC3339 time format for comparisons, from the MSH-7 segment. For example, `send_time < "2017-01-02T00:00:00-05:00"`. * `create_time`, the timestamp when the message was created in the HL7v2 store. Use the RFC3339 time format for comparisons. For example, `create_time < "2017-01-02T00:00:00-05:00"`. * `send_facility`, the care center that the message came from, from the MSH-4 segment. For example, `send_facility = "ABC"`. Note: The filter will be applied to every message in the HL7v2 store whose `send_time` lies in the range defined by the `start_time` and the `end_time`. Even if the filter only matches a small set of messages, the export operation can still take a long time to finish when a lot of messages are between the specified `start_time` and `end_time` range.' type: string gcsDestination: $ref: '#/components/schemas/GcsDestination' description: Export to a Cloud Storage destination. pubsubDestination: $ref: '#/components/schemas/PubsubDestination' description: Export messages to a Pub/Sub topic. startTime: description: The start of the range in `send_time` (MSH.7, https://www.hl7.org/documentcenter/public_temp_2E58C1F9-1C23-BA17-0C6126475344DA9D/wg/conf/HL7MSH.htm) to process. If not specified, the UNIX epoch (1970-01-01T00:00:00Z) is used. This value has to come before the `end_time` defined below. Only messages whose `send_time` lies in the range `start_time` (inclusive) to `end_time` (exclusive) are exported. format: google-datetime type: string type: object SchemaSegment: description: An HL7v2 Segment. properties: maxOccurs: description: The maximum number of times this segment can be present in this group. 0 or -1 means unbounded. format: int32 type: integer minOccurs: description: The minimum number of times this segment can be present in this group. format: int32 type: integer type: description: The Segment type. For example, "PID". type: string type: object FhirStoreMetrics: description: List of metrics for a given FHIR store. properties: metrics: description: List of FhirStoreMetric by resource type. items: $ref: '#/components/schemas/FhirStoreMetric' type: array name: description: The resource name of the FHIR store to get metrics for, in the format `projects/{project_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. type: string type: object ListConsentRevisionsResponse: properties: consents: description: The returned Consent revisions. The maximum number of revisions returned is determined by the value of `page_size` in the ListConsentRevisionsRequest. items: $ref: '#/components/schemas/Consent' type: array nextPageToken: description: Token to retrieve the next page of results, or empty if there are no more results in the list. type: string type: object Type: description: A type definition for some HL7v2 type (incl. Segments and Datatypes). properties: fields: description: The (sub) fields this type has (if not primitive). items: $ref: '#/components/schemas/Field' type: array name: description: The name of this type. This would be the segment or datatype name. For example, "PID" or "XPN". type: string primitive: description: If this is a primitive type then this field is the type of the primitive For example, STRING. Leave unspecified for composite types. enum: - PRIMITIVE_UNSPECIFIED - STRING - VARIES - UNESCAPED_STRING type: string type: object FhirFilter: description: Filter configuration. properties: resources: $ref: '#/components/schemas/Resources' description: List of resources to include in the output. If this list is empty or not specified, all resources are included in the output. type: object SetBlobStorageSettingsRequest: description: Request message for `SetBlobStorageSettings` method. properties: blobStorageSettings: $ref: '#/components/schemas/BlobStorageSettings' description: The blob storage settings to update for the specified resources. Only fields listed in `update_mask` are applied. filterConfig: $ref: '#/components/schemas/DicomFilterConfig' description: Optional. A filter configuration. 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}`. type: object Finding: properties: end: description: Zero-based ending index of the found text, exclusively. format: int64 type: string infoType: description: The type of information stored in this text range. For example, HumanName, BirthDate, or Address. type: string quote: description: The snippet of the sensitive text. This field is only populated during deidentification if `store_quote` is set to true in DeidentifyConfig. type: string start: description: Zero-based starting index of the found text, inclusively. format: int64 type: string type: object NotificationConfig: description: Specifies where to send notifications upon changes to a data store. properties: pubsubTopic: description: The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data contains the resource name. PubsubMessage.MessageId is the ID of this message. It is guaranteed to be unique within the topic. PubsubMessage.PublishTime is the time at which the message was published. Notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. Cloud Healthcare API service account must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail. If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). If the number of errors exceeds a certain rate, some aren't submitted. Note that not all operations trigger notifications, see [Configuring Pub/Sub notifications](https://cloud.google.com/healthcare/docs/how-tos/pubsub) for specific details. type: string sendForBulkImport: description: Indicates whether or not to send Pub/Sub notifications on bulk import. Only supported for DICOM imports. type: boolean type: object BatchGetMessagesResponse: description: Gets multiple messages in a specified HL7v2 store. properties: messages: description: The returned Messages. See `MessageView` for populated fields. items: $ref: '#/components/schemas/Message' type: array type: object TestIamPermissionsRequest: description: Request message for `TestIamPermissions` method. properties: permissions: description: The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). items: type: string type: array type: object IngestMessageRequest: description: Ingests a message into the specified HL7v2 store. properties: message: $ref: '#/components/schemas/Message' description: Required. HL7v2 message to ingest. type: object StudyMetrics: description: StudyMetrics contains metrics describing a DICOM study. properties: blobStorageSizeBytes: description: Total blob storage bytes for all instances in the study. format: int64 type: string instanceCount: description: Number of instances in the study. format: int64 type: string seriesCount: description: Number of series in the study. format: int64 type: string structuredStorageSizeBytes: description: Total structured storage bytes for all instances in the study. format: int64 type: string study: description: The study resource path. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}/dicomWeb/studies/{study_uid}`. type: string type: object DeidentifiedStoreDestination: description: Contains configuration for streaming de-identified FHIR export. properties: config: $ref: '#/components/schemas/DeidentifyConfig' description: The configuration to use when de-identifying resources that are added to this store. store: description: The full resource name of a Cloud Healthcare FHIR store, for example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. type: string type: object Hl7V2Store_2: description: Represents an HL7v2 store. properties: labels: additionalProperties: type: string description: 'User-supplied key-value pairs used to organize HL7v2 stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store.' type: object name: description: Identifier. Resource name of the HL7v2 store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`. type: string notificationConfig: $ref: '#/components/schemas/NotificationConfig' deprecated: true description: The notification destination all messages (both Ingest & Create) are published on. Only the message name is sent as part of the notification. If this is unset, no notifications are sent. Supplied by the client. notificationConfigs: description: A list of notification configs. Each configuration uses a filter to determine whether to publish a message (both Ingest & Create) on the corresponding notification destination. Only the message name is sent as part of the notification. Supplied by the client. items: $ref: '#/components/schemas/Hl7V2NotificationConfig_2' type: array parserConfig: $ref: '#/components/schemas/ParserConfig' description: The configuration for the parser. It determines how the server parses the messages. rejectDuplicateMessage: description: Determines whether to reject duplicate messages. A duplicate message is a message with the same raw bytes as a message that has already been ingested/created in this HL7v2 store. The default value is false, meaning that the store accepts the duplicate messages and it also returns the same ACK message in the IngestMessageResponse as has been returned previously. Note that only one resource is created in the store. When this field is set to true, CreateMessage/IngestMessage requests with a duplicate message will be rejected by the store, and IngestMessageErrorDetail returns a NACK message upon rejection. type: boolean type: object SearchParameter: description: Contains the versioned name and the URL for one SearchParameter. properties: canonicalUrl: description: The canonical url of the search parameter resource. type: string parameter: description: The versioned name of the search parameter resource. The format is projects/{project-id}/locations/{location}/datasets/{dataset-id}/fhirStores/{fhirStore-id}/fhir/SearchParameter/{resource-id}/_history/{version-id} For fhir stores with disable_resource_versioning=true, the format is projects/{project-id}/locations/{location}/datasets/{dataset-id}/fhirStores/{fhirStore-id}/fhir/SearchParameter/{resource-id}/ type: string type: object CheckDataAccessRequest: description: Checks if a particular data_id of a User data mapping in the given consent store is consented for a given use. properties: consentList: $ref: '#/components/schemas/ConsentList' description: Optional. Specific Consents to evaluate the access request against. These Consents must have the same `user_id` as the evaluated User data mapping, must exist in the current `consent_store`, and have a `state` of either `ACTIVE` or `DRAFT`. A maximum of 100 Consents can be provided here. If no selection is specified, the access request is evaluated against all `ACTIVE` unexpired Consents with the same `user_id` as the evaluated User data mapping. dataId: description: Required. The unique identifier of the resource to check access for. This identifier must correspond to a User data mapping in the given consent store. type: string requestAttributes: additionalProperties: type: string description: The values of request attributes associated with this access request. type: object responseView: description: Optional. The view for CheckDataAccessResponse. If unspecified, defaults to `BASIC` and returns `consented` as `TRUE` or `FALSE`. enum: - RESPONSE_VIEW_UNSPECIFIED - BASIC - FULL type: string type: object SchemaConfig: description: Configuration for the FHIR BigQuery schema. Determines how the server generates the schema. properties: lastUpdatedPartitionConfig: $ref: '#/components/schemas/TimePartitioning' description: The configuration for exported BigQuery tables to be partitioned by FHIR resource's last updated time column. recursiveStructureDepth: description: The depth for all recursive structures in the output analytics schema. For example, `concept` in the CodeSystem resource is a recursive structure; when the depth is 2, the CodeSystem table will have a column called `concept.concept` but not `concept.concept.concept`. If not specified or set to 0, the server will use the default value 2. The maximum depth allowed is 5. format: int64 type: string schemaType: description: Specifies the output schema type. Schema type is required. enum: - SCHEMA_TYPE_UNSPECIFIED - ANALYTICS - ANALYTICS_V2 type: string type: object ExportMessagesRequest: description: Request to schedule an export. properties: endTime: description: The end of the range in `send_time` (MSH.7, https://www.hl7.org/documentcenter/public_temp_2E58C1F9-1C23-BA17-0C6126475344DA9D/wg/conf/HL7MSH.htm) to process. If not specified, the time when the export is scheduled is used. This value has to come after the `start_time` defined below. Only messages whose `send_time` lies in the range `start_time` (inclusive) to `end_time` (exclusive) are exported. format: google-datetime type: string filter: description: 'Restricts messages exported to those matching a filter, only applicable to PubsubDestination. The following syntax is available: * A string field value can be written as text inside quotation marks, for example `"query text"`. The only valid relational operation for text fields is equality (`=`), where text is searched within the field, rather than having the field be equal to the text. For example, `"Comment = great"` returns messages with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in the `yyyy-mm-dd` format. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, and is just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. The following fields and functions are available for filtering: * `message_type`, from the MSH-9.1 field. For example, `NOT message_type = "ADT"`. * `send_date` or `sendDate`, the `yyyy-mm-dd` date the message was sent in the dataset''s time_zone, from the MSH-7 segment. For example, `send_date < "2017-01-02"`. * `send_time`, the timestamp when the message was sent, using the RFC3339 time format for comparisons, from the MSH-7 segment. For example, `send_time < "2017-01-02T00:00:00-05:00"`. * `create_time`, the timestamp when the message was created in the HL7v2 store. Use the RFC3339 time format for comparisons. For example, `create_time < "2017-01-02T00:00:00-05:00"`. * `send_facility`, the care center that the message came from, from the MSH-4 segment. For example, `send_facility = "ABC"`. Note: The filter will be applied to every message in the HL7v2 store whose `send_time` lies in the range defined by the `start_time` and the `end_time`. Even if the filter only matches a small set of messages, the export operation can still take a long time to finish when a lot of messages are between the specified `start_time` and `end_time` range.' type: string gcsDestination: $ref: '#/components/schemas/GcsDestination' description: Export to a Cloud Storage destination. pubsubDestination: $ref: '#/components/schemas/PubsubDestination' description: Export messages to a Pub/Sub topic. startTime: description: The start of the range in `send_time` (MSH.7, https://www.hl7.org/documentcenter/public_temp_2E58C1F9-1C23-BA17-0C6126475344DA9D/wg/conf/HL7MSH.htm) to process. If not specified, the UNIX epoch (1970-01-01T00:00:00Z) is used. This value has to come before the `end_time` defined below. Only messages whose `send_time` lies in the range `start_time` (inclusive) to `end_time` (exclusive) are exported. format: google-datetime type: string type: object GoogleCloudHealthcareV1beta1DicomStreamConfig: description: StreamConfig specifies configuration for a streaming DICOM export. properties: bigqueryDestination: $ref: '#/components/schemas/GoogleCloudHealthcareV1beta1DicomBigQueryDestination' description: 'Results are appended to this table. The server creates a new table in the given BigQuery dataset if the specified table does not exist. To enable the Cloud Healthcare API to write to your BigQuery table, you must give the Cloud Healthcare API service account the bigquery.dataEditor role. The service account is: `service-{PROJECT_NUMBER}@gcp-sa-healthcare.iam.gserviceaccount.com`. The PROJECT_NUMBER identifies the project that the DICOM store resides in. To get the project number, go to the Cloud Console Dashboard. It is recommended to not have a custom schema in the destination table which could conflict with the schema created by the Cloud Healthcare API. Instance deletions are not applied to the destination table. The destination''s table schema will be automatically updated in case a new instance''s data is incompatible with the current schema. The schema should not be updated manually as this can cause incompatibilies that cannot be resolved automatically. One resolution in this case is to delete the incompatible table and let the server recreate one, though the newly created table only contains data after the table recreation. BigQuery imposes a 1 MB limit on streaming insert row size, therefore any instance that generates more than 1 MB of BigQuery data will not be streamed. If an instance cannot be streamed to BigQuery, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)).' type: object SearchConfig: description: Contains the configuration for FHIR search. properties: searchParameters: description: A list of search parameters in this FHIR store that are used to configure this FHIR store. items: $ref: '#/components/schemas/SearchParameter' type: array type: object DicomStore: description: Represents a DICOM store. properties: labels: additionalProperties: type: string description: 'User-supplied key-value pairs used to organize DICOM stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store.' type: object name: description: Identifier. Resource name of the DICOM store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. type: string notificationConfig: $ref: '#/components/schemas/NotificationConfig' description: Notification destination for new DICOM instances. Supplied by the client. streamConfigs: description: Optional. A list of streaming configs used to configure the destination of streaming exports for every DICOM instance insertion in this DICOM store. After a new config is added to `stream_configs`, DICOM instance insertions are streamed to the new destination. When a config is removed from `stream_configs`, the server stops streaming to that destination. Each config must contain a unique destination. items: $ref: '#/components/schemas/GoogleCloudHealthcareV1DicomStreamConfig' type: array type: object Location: description: A resource that represents a Google Cloud location. properties: displayName: description: The friendly name for this location, typically a nearby city name. For example, "Tokyo". type: string labels: additionalProperties: type: string description: 'Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}' type: object locationId: description: 'The canonical id for this location. For example: `"us-east1"`.' type: string metadata: additionalProperties: description: Properties of the object. Contains field @type with type URL. description: Service-specific metadata. For example the available capacity at the given location. type: object name: description: 'Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`' type: string type: object AuditLogConfig: description: 'Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables ''DATA_READ'' and ''DATA_WRITE'' logging, while exempting jose@example.com from DATA_READ logging.' properties: exemptedMembers: description: Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. items: type: string type: array logType: description: The log type that this config enables. enum: - LOG_TYPE_UNSPECIFIED - ADMIN_READ - DATA_WRITE - DATA_READ type: string type: object parameters: uploadType: description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query name: uploadType schema: type: string fields: description: Selector specifying which fields to include in a partial response. in: query name: fields schema: type: string quotaUser: 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. in: query name: quotaUser schema: type: string _.xgafv: description: V1 error format. in: query name: $.xgafv schema: enum: - '1' - '2' type: string oauth_token: description: OAuth 2.0 token for the current user. in: query name: oauth_token schema: type: string prettyPrint: description: Returns response with indentations and line breaks. in: query name: prettyPrint schema: type: boolean alt: description: Data format for response. in: query name: alt schema: enum: - json - media - proto type: string access_token: description: OAuth access token. in: query name: access_token schema: type: string key: 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. in: query name: key schema: type: string callback: description: JSONP in: query name: callback schema: type: string upload_protocol: description: Upload protocol for media (e.g. "raw", "multipart"). in: query name: upload_protocol schema: type: string securitySchemes: Oauth2: description: Oauth 2.0 implicit authentication flows: implicit: authorizationUrl: https://accounts.google.com/o/oauth2/auth scopes: https://www.googleapis.com/auth/cloud-healthcare: Read, write and manage healthcare data https://www.googleapis.com/auth/cloud-platform: See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. type: oauth2 Oauth2c: description: Oauth 2.0 authorizationCode authentication flows: authorizationCode: authorizationUrl: https://accounts.google.com/o/oauth2/auth scopes: https://www.googleapis.com/auth/cloud-healthcare: Read, write and manage healthcare data https://www.googleapis.com/auth/cloud-platform: See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. tokenUrl: https://accounts.google.com/o/oauth2/token type: oauth2 externalDocs: url: https://cloud.google.com/healthcare x-hasEquivalentPaths: true