{ "uuid": "54235a4d-4520-4ad8-83af-5007a8cd6944", "lastMigration": 29, "name": "Cloud Healthcare API", "endpointPrefix": "", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "da7c5408-2ae4-4dda-ac3d-e811586d00ae", "documentation": "Checks if a particular data_id of a User data mapping in the specified consent store is consented for the specified use.", "method": "post", "endpoint": "v1beta1/:consentStore:checkDataAccess", "responses": [ { "uuid": "c4a54446-1cab-4f4d-96b0-a77c775b7d37", "body": "{\n \"consentDetails\": {},\n \"consented\": {{faker 'datatype.boolean'}}\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "68c15145-28a8-42c6-af97-48cd7f9c90fd", "documentation": "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.", "method": "post", "endpoint": "v1beta1/:consentStore:evaluateUserConsents", "responses": [ { "uuid": "f935825b-1ce1-4f79-a4f5-678cf69dc223", "body": "{\n \"nextPageToken\": \"\",\n \"results\": [\n {\n \"consentDetails\": {},\n \"consented\": {{faker 'datatype.boolean'}},\n \"dataId\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c6372283-cf75-4f28-9b8f-69b1eed8c317", "documentation": "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\" ```", "method": "post", "endpoint": "v1beta1/:consentStore:queryAccessibleData", "responses": [ { "uuid": "f6174737-fd88-4089-becb-9661cdc1d5e5", "body": "{\n \"done\": {{faker 'datatype.boolean'}},\n \"error\": {\n \"code\": {{faker 'number.int' max=99999}},\n \"details\": [\n {}\n ],\n \"message\": \"\"\n },\n \"metadata\": {},\n \"name\": \"\",\n \"response\": {}\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7d858fe7-8686-4a54-908a-3ac2270d5d3f", "documentation": "Deletes an HL7v2 message.", "method": "delete", "endpoint": "v1beta1/:name", "responses": [ { "uuid": "9f975a1f-ee0f-477e-ba4c-8e7a8d92e7b5", "body": "{}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5fbacd8d-1dab-4b5a-aeaa-3b448aa6f44c", "documentation": "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.", "method": "get", "endpoint": "v1beta1/:name", "responses": [ { "uuid": "97ea4799-663a-4798-b1a8-c2a3acf377fb", "body": "{\n \"done\": {{faker 'datatype.boolean'}},\n \"error\": {\n \"code\": {{faker 'number.int' max=99999}},\n \"details\": [\n {}\n ],\n \"message\": \"\"\n },\n \"metadata\": {},\n \"name\": \"\",\n \"response\": {}\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "0fefbed6-13ff-4685-a932-e044b5c3fbfa", "documentation": "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.", "method": "patch", "endpoint": "v1beta1/:name", "responses": [ { "uuid": "8039f133-e0bb-4509-82a6-a266c3a1c3b8", "body": "{\n \"createTime\": \"\",\n \"data\": \"\",\n \"labels\": {},\n \"messageType\": \"\",\n \"name\": \"\",\n \"parsedData\": {\n \"segments\": [\n {\n \"fields\": {},\n \"segmentId\": \"\",\n \"setId\": \"\"\n }\n ]\n },\n \"patientIds\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"schematizedData\": {\n \"data\": \"\",\n \"error\": \"\"\n },\n \"sendFacility\": \"\",\n \"sendTime\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e8d82c95-b57e-4c73-b63a-a3e8c59a80e7", "documentation": "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).", "method": "put", "endpoint": "v1beta1/:name", "responses": [ { "uuid": "581d2216-d12f-4e2f-b751-2a3b43b53fed", "body": "{\n \"contentType\": \"\",\n \"data\": \"\",\n \"extensions\": [\n {}\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "daac5b4f-f62b-4c47-bf02-6935da5159ab", "documentation": "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).", "method": "get", "endpoint": "v1beta1/:name/$everything", "responses": [ { "uuid": "74e6c7ec-48ec-446d-b1fa-d08033e9ac56", "body": "{\n \"contentType\": \"\",\n \"data\": \"\",\n \"extensions\": [\n {}\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f2f3277a-aec9-4497-aebb-ae51c67c2d11", "documentation": "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).", "method": "delete", "endpoint": "v1beta1/:name/$purge", "responses": [ { "uuid": "11b2f5ee-4a13-416e-9b32-231d451ccf2f", "body": "{}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "bbcf78ca-f7bd-4cac-b154-f0e300051add", "documentation": "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.", "method": "get", "endpoint": "v1beta1/:name/$translate", "responses": [ { "uuid": "361328d1-4cee-41e4-8aeb-2875a326f154", "body": "{\n \"contentType\": \"\",\n \"data\": \"\",\n \"extensions\": [\n {}\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "93db756e-6eaf-4704-9c1d-c65d5a9aeffb", "documentation": "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).", "method": "get", "endpoint": "v1beta1/:name/_history", "responses": [ { "uuid": "a641db7b-f0cf-4537-bf48-16f1ca0da66a", "body": "{\n \"contentType\": \"\",\n \"data\": \"\",\n \"extensions\": [\n {}\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ea559d40-f267-4e56-861a-4ea13775e4ed", "documentation": "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.", "method": "get", "endpoint": "v1beta1/:name/fhir/metadata", "responses": [ { "uuid": "0011e465-1507-495f-b787-67386bd99b8d", "body": "{\n \"contentType\": \"\",\n \"data\": \"\",\n \"extensions\": [\n {}\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2ab8e7f1-6186-4efe-ac8c-462c836da3af", "documentation": "Lists information about the supported locations for this service.", "method": "get", "endpoint": "v1beta1/:name/locations", "responses": [ { "uuid": "3f75482f-0ca2-4208-8786-7a1a8e35741f", "body": "{\n \"locations\": [\n {\n \"displayName\": \"\",\n \"labels\": {},\n \"locationId\": \"\",\n \"metadata\": {},\n \"name\": \"\"\n }\n ],\n \"nextPageToken\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "14852c49-81cf-4b77-a757-3e399618b817", "documentation": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.", "method": "get", "endpoint": "v1beta1/:name/operations", "responses": [ { "uuid": "449b2d9a-d3ba-4666-805b-94b622d66775", "body": "{\n \"nextPageToken\": \"\",\n \"operations\": [\n {\n \"done\": {{faker 'datatype.boolean'}},\n \"error\": {\n \"code\": {{faker 'number.int' max=99999}},\n \"details\": [\n {}\n ],\n \"message\": \"\"\n },\n \"metadata\": {},\n \"name\": \"\",\n \"response\": {}\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7479c7e0-7ff8-4c16-a1a1-e55ba0412f67", "documentation": "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.", "method": "post", "endpoint": "v1beta1/:name:activate", "responses": [ { "uuid": "c4c2ab5d-11fb-44bd-9160-d84339692ccb", "body": "{\n \"consentArtifact\": \"\",\n \"expireTime\": \"\",\n \"metadata\": {},\n \"name\": \"\",\n \"policies\": [\n {\n \"authorizationRule\": {\n \"description\": \"\",\n \"expression\": \"\",\n \"location\": \"\",\n \"title\": \"\"\n },\n \"resourceAttributes\": [\n {\n \"attributeDefinitionId\": \"\",\n \"values\": [\n \"\"\n ]\n }\n ]\n }\n ],\n \"revisionCreateTime\": \"\",\n \"revisionId\": \"\",\n \"state\": \"{{oneOf (array 'STATE_UNSPECIFIED' 'ACTIVE' 'ARCHIVED' 'REVOKED' 'DRAFT' 'REJECTED')}}\",\n \"ttl\": \"\",\n \"userId\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e9474a6b-0737-4d9f-af2e-f688e3ec4d47", "documentation": "Archives the specified User data mapping.", "method": "post", "endpoint": "v1beta1/:name:archive", "responses": [ { "uuid": "1a6078b4-ba84-40cf-8903-88d50a527fcf", "body": "{}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b0e86882-4221-4e46-bf78-30c1f94b7576", "documentation": "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`.", "method": "post", "endpoint": "v1beta1/:name:cancel", "responses": [ { "uuid": "cfc2503f-0d09-4d7e-80f7-5eca1342d7d8", "body": "{}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2ac81ff4-e1ec-4803-b69a-aaab0be79b98", "documentation": "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.", "method": "post", "endpoint": "v1beta1/:name:configureSearch", "responses": [ { "uuid": "fa8eb32c-ef7b-40a9-a4b3-71be8aa6bb9e", "body": "{\n \"done\": {{faker 'datatype.boolean'}},\n \"error\": {\n \"code\": {{faker 'number.int' max=99999}},\n \"details\": [\n {}\n ],\n \"message\": \"\"\n },\n \"metadata\": {},\n \"name\": \"\",\n \"response\": {}\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1b2e153a-4f0f-4593-bfca-a5bce4175ba3", "documentation": "Deletes the specified revision of a Consent. An INVALID_ARGUMENT error occurs if the specified revision is the latest revision.", "method": "delete", "endpoint": "v1beta1/:name:deleteRevision", "responses": [ { "uuid": "dc8e6cad-3678-42db-afd5-b823bd3395cb", "body": "{}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "66253272-c6d0-4108-a863-e46f58699ed5", "documentation": "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)).", "method": "post", "endpoint": "v1beta1/:name:evaluate", "responses": [ { "uuid": "9e392771-4b09-4fff-9278-dfdbd8a6811d", "body": "{\n \"done\": {{faker 'datatype.boolean'}},\n \"error\": {\n \"code\": {{faker 'number.int' max=99999}},\n \"details\": [\n {}\n ],\n \"message\": \"\"\n },\n \"metadata\": {},\n \"name\": \"\",\n \"response\": {}\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a3c10234-2934-457e-980b-75ecf3a93c96", "documentation": "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.", "method": "post", "endpoint": "v1beta1/:name:export", "responses": [ { "uuid": "48b48a7a-461b-4056-8fd8-cad3cec5d0a5", "body": "{\n \"done\": {{faker 'datatype.boolean'}},\n \"error\": {\n \"code\": {{faker 'number.int' max=99999}},\n \"details\": [\n {}\n ],\n \"message\": \"\"\n },\n \"metadata\": {},\n \"name\": \"\",\n \"response\": {}\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "8dcc5879-a34f-4c7d-94aa-c395cea4df22", "documentation": "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.", "method": "post", "endpoint": "v1beta1/:name:import", "responses": [ { "uuid": "b356b656-9506-457f-ba24-ca1c30839af7", "body": "{\n \"done\": {{faker 'datatype.boolean'}},\n \"error\": {\n \"code\": {{faker 'number.int' max=99999}},\n \"details\": [\n {}\n ],\n \"message\": \"\"\n },\n \"metadata\": {},\n \"name\": \"\",\n \"response\": {}\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "eb52377a-e4b5-4b20-a4c4-8fa86297b3fe", "documentation": "Lists the revisions of the specified Consent in reverse chronological order.", "method": "get", "endpoint": "v1beta1/:name:listRevisions", "responses": [ { "uuid": "b0d9106a-f6e2-414a-8567-cb8edb38842a", "body": "{\n \"consents\": [\n {\n \"consentArtifact\": \"\",\n \"expireTime\": \"\",\n \"metadata\": {},\n \"name\": \"\",\n \"policies\": [\n {\n \"authorizationRule\": {\n \"description\": \"\",\n \"expression\": \"\",\n \"location\": \"\",\n \"title\": \"\"\n },\n \"resourceAttributes\": [\n {\n \"attributeDefinitionId\": \"\",\n \"values\": [\n \"\"\n ]\n }\n ]\n }\n ],\n \"revisionCreateTime\": \"\",\n \"revisionId\": \"\",\n \"state\": \"{{oneOf (array 'STATE_UNSPECIFIED' 'ACTIVE' 'ARCHIVED' 'REVOKED' 'DRAFT' 'REJECTED')}}\",\n \"ttl\": \"\",\n \"userId\": \"\"\n }\n ],\n \"nextPageToken\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7b85b3cd-6f1b-4c67-ad8b-b400f2b40b7c", "documentation": "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.", "method": "post", "endpoint": "v1beta1/:name:reject", "responses": [ { "uuid": "92afb85c-4cd7-481f-8993-7d07a3476f3c", "body": "{\n \"consentArtifact\": \"\",\n \"expireTime\": \"\",\n \"metadata\": {},\n \"name\": \"\",\n \"policies\": [\n {\n \"authorizationRule\": {\n \"description\": \"\",\n \"expression\": \"\",\n \"location\": \"\",\n \"title\": \"\"\n },\n \"resourceAttributes\": [\n {\n \"attributeDefinitionId\": \"\",\n \"values\": [\n \"\"\n ]\n }\n ]\n }\n ],\n \"revisionCreateTime\": \"\",\n \"revisionId\": \"\",\n \"state\": \"{{oneOf (array 'STATE_UNSPECIFIED' 'ACTIVE' 'ARCHIVED' 'REVOKED' 'DRAFT' 'REJECTED')}}\",\n \"ttl\": \"\",\n \"userId\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1b6d6612-f556-4664-8ef9-99ef5d5c0c70", "documentation": "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.", "method": "post", "endpoint": "v1beta1/:name:revoke", "responses": [ { "uuid": "2b43c3b1-f2b5-4c46-a1ba-303d4b8ea0e5", "body": "{\n \"consentArtifact\": \"\",\n \"expireTime\": \"\",\n \"metadata\": {},\n \"name\": \"\",\n \"policies\": [\n {\n \"authorizationRule\": {\n \"description\": \"\",\n \"expression\": \"\",\n \"location\": \"\",\n \"title\": \"\"\n },\n \"resourceAttributes\": [\n {\n \"attributeDefinitionId\": \"\",\n \"values\": [\n \"\"\n ]\n }\n ]\n }\n ],\n \"revisionCreateTime\": \"\",\n \"revisionId\": \"\",\n \"state\": \"{{oneOf (array 'STATE_UNSPECIFIED' 'ACTIVE' 'ARCHIVED' 'REVOKED' 'DRAFT' 'REJECTED')}}\",\n \"ttl\": \"\",\n \"userId\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "56e5f384-91ed-4444-b1a8-9665802d6af1", "documentation": "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.", "method": "post", "endpoint": "v1beta1/:nlpService:analyzeEntities", "responses": [ { "uuid": "e9e75a6c-5fde-4e48-96b6-a80c3bd67216", "body": "{\n \"entities\": [\n {\n \"entityId\": \"\",\n \"preferredTerm\": \"\",\n \"vocabularyCodes\": [\n \"\"\n ]\n }\n ],\n \"entityMentions\": [\n {\n \"certaintyAssessment\": {\n \"confidence\": {{faker 'number.float'}},\n \"value\": \"\"\n },\n \"confidence\": {{faker 'number.float'}},\n \"linkedEntities\": [\n {\n \"entityId\": \"\"\n }\n ],\n \"mentionId\": \"\",\n \"subject\": {\n \"confidence\": {{faker 'number.float'}},\n \"value\": \"\"\n },\n \"temporalAssessment\": {\n \"confidence\": {{faker 'number.float'}},\n \"value\": \"\"\n },\n \"text\": {\n \"beginOffset\": {{faker 'number.int' max=99999}},\n \"content\": \"\"\n },\n \"type\": \"\"\n }\n ],\n \"relationships\": [\n {\n \"confidence\": {{faker 'number.float'}},\n \"objectId\": \"\",\n \"subjectId\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "701b3a9a-b0ff-499b-adcb-c698f59d2b08", "documentation": "Lists the Annotation stores in the given dataset for a source store.", "method": "get", "endpoint": "v1beta1/:parent/annotationStores", "responses": [ { "uuid": "d88b6127-e912-4a91-aa5b-dbddebb03594", "body": "{\n \"annotationStores\": [\n {\n \"labels\": {},\n \"name\": \"\"\n }\n ],\n \"nextPageToken\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "67459827-899b-4854-891e-730a2b341b86", "documentation": "Creates a new Annotation store within the parent dataset.", "method": "post", "endpoint": "v1beta1/:parent/annotationStores", "responses": [ { "uuid": "f709e4da-8214-42ff-8279-7c2d27d49ce5", "body": "{\n \"labels\": {},\n \"name\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2fb558f3-6669-49d6-9fd2-051667b29e39", "documentation": "Lists the Annotations in the given Annotation store for a source resource.", "method": "get", "endpoint": "v1beta1/:parent/annotations", "responses": [ { "uuid": "9c18838e-299d-407d-8a24-64f65122b1eb", "body": "{\n \"annotations\": [\n {\n \"annotationSource\": {\n \"cloudHealthcareSource\": {\n \"name\": \"\"\n }\n },\n \"customData\": {},\n \"imageAnnotation\": {\n \"boundingPolys\": [\n {\n \"label\": \"\",\n \"vertices\": [\n {\n \"x\": {{faker 'number.float'}},\n \"y\": {{faker 'number.float'}}\n }\n ]\n }\n ],\n \"frameIndex\": {{faker 'number.int' max=99999}}\n },\n \"name\": \"\",\n \"resourceAnnotation\": {\n \"label\": \"\"\n },\n \"textAnnotation\": {\n \"details\": {}\n }\n }\n ],\n \"nextPageToken\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b6cf84af-f712-41af-be14-7c98c5af67af", "documentation": "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.", "method": "post", "endpoint": "v1beta1/:parent/annotations", "responses": [ { "uuid": "382c9731-4d9c-41b5-a7b4-3069d09a4fec", "body": "{\n \"annotationSource\": {\n \"cloudHealthcareSource\": {\n \"name\": \"\"\n }\n },\n \"customData\": {},\n \"imageAnnotation\": {\n \"boundingPolys\": [\n {\n \"label\": \"\",\n \"vertices\": [\n {\n \"x\": {{faker 'number.float'}},\n \"y\": {{faker 'number.float'}}\n }\n ]\n }\n ],\n \"frameIndex\": {{faker 'number.int' max=99999}}\n },\n \"name\": \"\",\n \"resourceAnnotation\": {\n \"label\": \"\"\n },\n \"textAnnotation\": {\n \"details\": {}\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9472bd77-05b3-4006-b371-81bc92a67d18", "documentation": "Lists the Attribute definitions in the specified consent store.", "method": "get", "endpoint": "v1beta1/:parent/attributeDefinitions", "responses": [ { "uuid": "2809a36e-4df3-427a-80b9-91c5da4fb5dd", "body": "{\n \"attributeDefinitions\": [\n {\n \"allowedValues\": [\n \"\"\n ],\n \"category\": \"{{oneOf (array 'CATEGORY_UNSPECIFIED' 'RESOURCE' 'REQUEST')}}\",\n \"consentDefaultValues\": [\n \"\"\n ],\n \"dataMappingDefaultValue\": \"\",\n \"description\": \"\",\n \"name\": \"\"\n }\n ],\n \"nextPageToken\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "487f2b0c-ce4a-4c55-8b1e-cec67fa2e9a8", "documentation": "Creates a new Attribute definition in the parent consent store.", "method": "post", "endpoint": "v1beta1/:parent/attributeDefinitions", "responses": [ { "uuid": "93c9f359-c76b-4b9b-9041-5db5b26583b7", "body": "{\n \"allowedValues\": [\n \"\"\n ],\n \"category\": \"{{oneOf (array 'CATEGORY_UNSPECIFIED' 'RESOURCE' 'REQUEST')}}\",\n \"consentDefaultValues\": [\n \"\"\n ],\n \"dataMappingDefaultValue\": \"\",\n \"description\": \"\",\n \"name\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1a5c61ea-9f2e-444a-959f-e2b075d5bf6d", "documentation": "Lists the Consent artifacts in the specified consent store.", "method": "get", "endpoint": "v1beta1/:parent/consentArtifacts", "responses": [ { "uuid": "067855ff-8ff9-449a-8195-d1e88e2aefb2", "body": "{\n \"consentArtifacts\": [\n {\n \"consentContentScreenshots\": [\n {\n \"gcsUri\": \"\",\n \"rawBytes\": \"\"\n }\n ],\n \"consentContentVersion\": \"\",\n \"guardianSignature\": {\n \"image\": {\n \"gcsUri\": \"\",\n \"rawBytes\": \"\"\n },\n \"metadata\": {},\n \"signatureTime\": \"\",\n \"userId\": \"\"\n },\n \"metadata\": {},\n \"name\": \"\",\n \"userId\": \"\",\n \"userSignature\": {\n \"image\": {\n \"gcsUri\": \"\",\n \"rawBytes\": \"\"\n },\n \"metadata\": {},\n \"signatureTime\": \"\",\n \"userId\": \"\"\n },\n \"witnessSignature\": {\n \"image\": {\n \"gcsUri\": \"\",\n \"rawBytes\": \"\"\n },\n \"metadata\": {},\n \"signatureTime\": \"\",\n \"userId\": \"\"\n }\n }\n ],\n \"nextPageToken\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7d523a4a-ac36-4991-951e-c84b7753e097", "documentation": "Creates a new Consent artifact in the parent consent store.", "method": "post", "endpoint": "v1beta1/:parent/consentArtifacts", "responses": [ { "uuid": "e21d3106-1528-49ff-8f62-d36b18d86d9f", "body": "{\n \"consentContentScreenshots\": [\n {\n \"gcsUri\": \"\",\n \"rawBytes\": \"\"\n }\n ],\n \"consentContentVersion\": \"\",\n \"guardianSignature\": {\n \"image\": {\n \"gcsUri\": \"\",\n \"rawBytes\": \"\"\n },\n \"metadata\": {},\n \"signatureTime\": \"\",\n \"userId\": \"\"\n },\n \"metadata\": {},\n \"name\": \"\",\n \"userId\": \"\",\n \"userSignature\": {\n \"image\": {\n \"gcsUri\": \"\",\n \"rawBytes\": \"\"\n },\n \"metadata\": {},\n \"signatureTime\": \"\",\n \"userId\": \"\"\n },\n \"witnessSignature\": {\n \"image\": {\n \"gcsUri\": \"\",\n \"rawBytes\": \"\"\n },\n \"metadata\": {},\n \"signatureTime\": \"\",\n \"userId\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2f8e58ba-9935-4629-a231-f8871c8355c7", "documentation": "Lists the consent stores in the specified dataset.", "method": "get", "endpoint": "v1beta1/:parent/consentStores", "responses": [ { "uuid": "e40cb865-560b-411b-9d45-0a5d2f80382e", "body": "{\n \"consentStores\": [\n {\n \"defaultConsentTtl\": \"\",\n \"enableConsentCreateOnUpdate\": {{faker 'datatype.boolean'}},\n \"labels\": {},\n \"name\": \"\"\n }\n ],\n \"nextPageToken\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1c121019-9ab2-40b3-a79d-89cdcce128dd", "documentation": "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.", "method": "post", "endpoint": "v1beta1/:parent/consentStores", "responses": [ { "uuid": "a62c6695-53ae-4098-9ae0-ec81add919d2", "body": "{\n \"defaultConsentTtl\": \"\",\n \"enableConsentCreateOnUpdate\": {{faker 'datatype.boolean'}},\n \"labels\": {},\n \"name\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d98fd08f-0550-44f1-b40d-105cea0e01f6", "documentation": "Lists the Consent in the given consent store, returning each Consent's latest revision.", "method": "get", "endpoint": "v1beta1/:parent/consents", "responses": [ { "uuid": "5b48d984-1bc5-4676-80ca-b9d0b1edce45", "body": "{\n \"consents\": [\n {\n \"consentArtifact\": \"\",\n \"expireTime\": \"\",\n \"metadata\": {},\n \"name\": \"\",\n \"policies\": [\n {\n \"authorizationRule\": {\n \"description\": \"\",\n \"expression\": \"\",\n \"location\": \"\",\n \"title\": \"\"\n },\n \"resourceAttributes\": [\n {\n \"attributeDefinitionId\": \"\",\n \"values\": [\n \"\"\n ]\n }\n ]\n }\n ],\n \"revisionCreateTime\": \"\",\n \"revisionId\": \"\",\n \"state\": \"{{oneOf (array 'STATE_UNSPECIFIED' 'ACTIVE' 'ARCHIVED' 'REVOKED' 'DRAFT' 'REJECTED')}}\",\n \"ttl\": \"\",\n \"userId\": \"\"\n }\n ],\n \"nextPageToken\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "4c219300-685c-420f-bc53-86b05ccd05e7", "documentation": "Creates a new Consent in the parent consent store.", "method": "post", "endpoint": "v1beta1/:parent/consents", "responses": [ { "uuid": "275adf88-8852-49b6-9eeb-9a7101af59ca", "body": "{\n \"consentArtifact\": \"\",\n \"expireTime\": \"\",\n \"metadata\": {},\n \"name\": \"\",\n \"policies\": [\n {\n \"authorizationRule\": {\n \"description\": \"\",\n \"expression\": \"\",\n \"location\": \"\",\n \"title\": \"\"\n },\n \"resourceAttributes\": [\n {\n \"attributeDefinitionId\": \"\",\n \"values\": [\n \"\"\n ]\n }\n ]\n }\n ],\n \"revisionCreateTime\": \"\",\n \"revisionId\": \"\",\n \"state\": \"{{oneOf (array 'STATE_UNSPECIFIED' 'ACTIVE' 'ARCHIVED' 'REVOKED' 'DRAFT' 'REJECTED')}}\",\n \"ttl\": \"\",\n \"userId\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d1bfecb1-3bbe-4c60-bd1e-9b582442d5d5", "documentation": "Lists the health datasets in the current project.", "method": "get", "endpoint": "v1beta1/:parent/datasets", "responses": [ { "uuid": "3979b111-fca9-4b63-b5fe-6900a825d30e", "body": "{\n \"datasets\": [\n {\n \"name\": \"\",\n \"timeZone\": \"\"\n }\n ],\n \"nextPageToken\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ebc17540-119b-4f26-bbf2-73f9f20da98a", "documentation": "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.", "method": "post", "endpoint": "v1beta1/:parent/datasets", "responses": [ { "uuid": "f4d56cc8-6a9a-4152-964d-dbb9a7c52750", "body": "{\n \"done\": {{faker 'datatype.boolean'}},\n \"error\": {\n \"code\": {{faker 'number.int' max=99999}},\n \"details\": [\n {}\n ],\n \"message\": \"\"\n },\n \"metadata\": {},\n \"name\": \"\",\n \"response\": {}\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "66afa476-1e93-4e0d-84e8-349600a05d2f", "documentation": "Lists the DICOM stores in the given dataset.", "method": "get", "endpoint": "v1beta1/:parent/dicomStores", "responses": [ { "uuid": "f016f515-c345-475d-84e7-c2fb626be6b3", "body": "{\n \"dicomStores\": [\n {\n \"labels\": {},\n \"name\": \"\",\n \"notificationConfig\": {\n \"pubsubTopic\": \"\",\n \"sendForBulkImport\": {{faker 'datatype.boolean'}}\n },\n \"streamConfigs\": [\n {\n \"bigqueryDestination\": {\n \"force\": {{faker 'datatype.boolean'}},\n \"tableUri\": \"\",\n \"writeDisposition\": \"{{oneOf (array 'WRITE_DISPOSITION_UNSPECIFIED' 'WRITE_EMPTY' 'WRITE_TRUNCATE' 'WRITE_APPEND')}}\"\n }\n }\n ]\n }\n ],\n \"nextPageToken\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3ef4a153-2f69-4b80-bd41-6ddd883fbfb1", "documentation": "Creates a new DICOM store within the parent dataset.", "method": "post", "endpoint": "v1beta1/:parent/dicomStores", "responses": [ { "uuid": "3fca83cb-bb16-4fc5-8a0a-9b4957a889dd", "body": "{\n \"labels\": {},\n \"name\": \"\",\n \"notificationConfig\": {\n \"pubsubTopic\": \"\",\n \"sendForBulkImport\": {{faker 'datatype.boolean'}}\n },\n \"streamConfigs\": [\n {\n \"bigqueryDestination\": {\n \"force\": {{faker 'datatype.boolean'}},\n \"tableUri\": \"\",\n \"writeDisposition\": \"{{oneOf (array 'WRITE_DISPOSITION_UNSPECIFIED' 'WRITE_EMPTY' 'WRITE_TRUNCATE' 'WRITE_APPEND')}}\"\n }\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7d108b43-2f47-463f-959e-77b5b4f3dbd7", "documentation": "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 [Deleting a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#deleting_a_study_series_or_instance).", "method": "delete", "endpoint": "v1beta1/:parent/dicomWeb/:dicomWebPath", "responses": [ { "uuid": "52eb279a-551c-46dc-baac-665dea383b7e", "body": "{}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3290fc9e-2d1a-4781-846b-0c5c2930c95f", "documentation": "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 [Retrieving consumer image formats](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_consumer_image_formats).", "method": "get", "endpoint": "v1beta1/:parent/dicomWeb/:dicomWebPath", "responses": [ { "uuid": "a445bab3-ee70-4bc6-9051-b8463ec170d2", "body": "{\n \"contentType\": \"\",\n \"data\": \"\",\n \"extensions\": [\n {}\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7912fda0-d617-4e5e-bf18-377767833efa", "documentation": "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 [Storing DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#storing_dicom_data).", "method": "post", "endpoint": "v1beta1/:parent/dicomWeb/:dicomWebPath", "responses": [ { "uuid": "d28d99b8-19cf-485b-ba92-0c5deaa485d7", "body": "{\n \"contentType\": \"\",\n \"data\": \"\",\n \"extensions\": [\n {}\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "15b32189-914a-4c89-a1e2-5fc5e49265a2", "documentation": "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).", "method": "post", "endpoint": "v1beta1/:parent/fhir", "responses": [ { "uuid": "5ca6e913-4ab5-4455-afa1-8573189f798a", "body": "{\n \"contentType\": \"\",\n \"data\": \"\",\n \"extensions\": [\n {}\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "fb23e0ef-729e-4836-a73c-17ff36aa97da", "documentation": "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.", "method": "get", "endpoint": "v1beta1/:parent/fhir/ConceptMap/$translate", "responses": [ { "uuid": "a78d970a-f63a-4de8-b14d-37bbc7790bef", "body": "{\n \"contentType\": \"\",\n \"data\": \"\",\n \"extensions\": [\n {}\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e8178bb7-7dfb-4a6a-bb05-ffd101cab62f", "documentation": "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.", "method": "get", "endpoint": "v1beta1/:parent/fhir/Observation/$lastn", "responses": [ { "uuid": "4bd11761-af64-4e15-8682-58b4e770c12f", "body": "{\n \"contentType\": \"\",\n \"data\": \"\",\n \"extensions\": [\n {}\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "133a2e7e-03a5-4254-9669-675928f14252", "documentation": "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`. 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. 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 changes and when the change is reflected in search results. 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).", "method": "post", "endpoint": "v1beta1/:parent/fhir/_search", "responses": [ { "uuid": "5f1992b4-5b9c-43a6-95fe-61c0f042185f", "body": "{\n \"contentType\": \"\",\n \"data\": \"\",\n \"extensions\": [\n {}\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c39e80df-661d-4d52-9e25-256c24ce9448", "documentation": "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`. 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. 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 changes and when the change is reflected in search results. 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).", "method": "post", "endpoint": "v1beta1/:parent/fhir/:resourceType/_search", "responses": [ { "uuid": "988d9b80-0ace-4ad6-b512-d8df4aa02b45", "body": "{\n \"contentType\": \"\",\n \"data\": \"\",\n \"extensions\": [\n {}\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "426728e9-3888-437a-b69a-12177303a0eb", "documentation": "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).", "method": "delete", "endpoint": "v1beta1/:parent/fhir/:type", "responses": [ { "uuid": "ce467d61-a9c9-42b5-b413-5ee05cbee720", "body": "{}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7c77d32e-e566-40c7-83f9-8e304fcc5070", "documentation": "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).", "method": "patch", "endpoint": "v1beta1/:parent/fhir/:type", "responses": [ { "uuid": "216d344d-6f5d-4315-a7a6-2fdaab2a8162", "body": "{\n \"contentType\": \"\",\n \"data\": \"\",\n \"extensions\": [\n {}\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "8555ba09-fb51-4a09-8e97-54e4673af95f", "documentation": "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).", "method": "post", "endpoint": "v1beta1/:parent/fhir/:type", "responses": [ { "uuid": "8904a069-7b19-4e72-9476-7383df12e314", "body": "{\n \"contentType\": \"\",\n \"data\": \"\",\n \"extensions\": [\n {}\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f6dea82e-55cf-4af8-bb43-90ba93c5f188", "documentation": "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).", "method": "put", "endpoint": "v1beta1/:parent/fhir/:type", "responses": [ { "uuid": "f1618d23-7983-48ab-a138-4ff71e9425d9", "body": "{\n \"contentType\": \"\",\n \"data\": \"\",\n \"extensions\": [\n {}\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1c3d5641-2cc2-4e48-acd4-8cca540e1f5d", "documentation": "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.", "method": "post", "endpoint": "v1beta1/:parent/fhir/:type/$validate", "responses": [ { "uuid": "47fcad6d-19ff-488e-90af-0d323dcda586", "body": "{\n \"contentType\": \"\",\n \"data\": \"\",\n \"extensions\": [\n {}\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f2da3ec5-ec00-4fbc-a428-f1912775fde8", "documentation": "Lists the FHIR stores in the given dataset.", "method": "get", "endpoint": "v1beta1/:parent/fhirStores", "responses": [ { "uuid": "1874d9ef-1975-46ea-b909-9645ca1d77af", "body": "{\n \"fhirStores\": [\n {\n \"complexDataTypeReferenceParsing\": \"{{oneOf (array 'COMPLEX_DATA_TYPE_REFERENCE_PARSING_UNSPECIFIED' 'DISABLED' 'ENABLED')}}\",\n \"defaultSearchHandlingStrict\": {{faker 'datatype.boolean'}},\n \"disableReferentialIntegrity\": {{faker 'datatype.boolean'}},\n \"disableResourceVersioning\": {{faker 'datatype.boolean'}},\n \"enableUpdateCreate\": {{faker 'datatype.boolean'}},\n \"labels\": {},\n \"name\": \"\",\n \"notificationConfig\": {\n \"pubsubTopic\": \"\",\n \"sendForBulkImport\": {{faker 'datatype.boolean'}}\n },\n \"notificationConfigs\": [\n {\n \"pubsubTopic\": \"\",\n \"sendFullResource\": {{faker 'datatype.boolean'}}\n }\n ],\n \"searchConfig\": {\n \"searchParameters\": [\n {\n \"canonicalUrl\": \"\",\n \"parameter\": \"\"\n }\n ]\n },\n \"streamConfigs\": [\n {\n \"bigqueryDestination\": {\n \"datasetUri\": \"\",\n \"force\": {{faker 'datatype.boolean'}},\n \"schemaConfig\": {\n \"recursiveStructureDepth\": \"\",\n \"schemaType\": \"{{oneOf (array 'SCHEMA_TYPE_UNSPECIFIED' 'LOSSLESS' 'ANALYTICS' 'ANALYTICS_V2')}}\"\n },\n \"writeDisposition\": \"{{oneOf (array 'WRITE_DISPOSITION_UNSPECIFIED' 'WRITE_EMPTY' 'WRITE_TRUNCATE' 'WRITE_APPEND')}}\"\n },\n \"deidentifiedStoreDestination\": {\n \"config\": {\n \"annotation\": {\n \"annotationStoreName\": \"\",\n \"storeQuote\": {{faker 'datatype.boolean'}}\n },\n \"dicom\": {\n \"filterProfile\": \"{{oneOf (array 'TAG_FILTER_PROFILE_UNSPECIFIED' 'MINIMAL_KEEP_LIST_PROFILE' 'ATTRIBUTE_CONFIDENTIALITY_BASIC_PROFILE' 'KEEP_ALL_PROFILE' 'DEIDENTIFY_TAG_CONTENTS')}}\",\n \"keepList\": {\n \"tags\": [\n \"\"\n ]\n },\n \"removeList\": {\n \"tags\": [\n \"\"\n ]\n },\n \"skipIdRedaction\": {{faker 'datatype.boolean'}}\n },\n \"fhir\": {\n \"defaultKeepExtensions\": {{faker 'datatype.boolean'}},\n \"fieldMetadataList\": [\n {\n \"action\": \"{{oneOf (array 'ACTION_UNSPECIFIED' 'TRANSFORM' 'INSPECT_AND_TRANSFORM' 'DO_NOT_TRANSFORM')}}\",\n \"paths\": [\n \"\"\n ]\n }\n ]\n },\n \"image\": {\n \"textRedactionMode\": \"{{oneOf (array 'TEXT_REDACTION_MODE_UNSPECIFIED' 'REDACT_ALL_TEXT' 'REDACT_SENSITIVE_TEXT' 'REDACT_NO_TEXT')}}\"\n },\n \"operationMetadata\": {\n \"fhirOutput\": {\n \"fhirStore\": \"\"\n }\n },\n \"text\": {\n \"transformations\": [\n {\n \"characterMaskConfig\": {\n \"maskingCharacter\": \"\"\n },\n \"cryptoHashConfig\": {\n \"cryptoKey\": \"\",\n \"kmsWrapped\": {\n \"cryptoKey\": \"\",\n \"wrappedKey\": \"\"\n }\n },\n \"dateShiftConfig\": {\n \"cryptoKey\": \"\",\n \"kmsWrapped\": {\n \"cryptoKey\": \"\",\n \"wrappedKey\": \"\"\n }\n },\n \"infoTypes\": [\n \"\"\n ],\n \"redactConfig\": {},\n \"replaceWithInfoTypeConfig\": {}\n }\n ]\n }\n },\n \"store\": \"\"\n },\n \"resourceTypes\": [\n \"\"\n ]\n }\n ],\n \"validationConfig\": {\n \"disableFhirpathValidation\": {{faker 'datatype.boolean'}},\n \"disableProfileValidation\": {{faker 'datatype.boolean'}},\n \"disableReferenceTypeValidation\": {{faker 'datatype.boolean'}},\n \"disableRequiredFieldValidation\": {{faker 'datatype.boolean'}},\n \"enabledImplementationGuides\": [\n \"\"\n ]\n },\n \"version\": \"{{oneOf (array 'VERSION_UNSPECIFIED' 'DSTU2' 'STU3' 'R4')}}\"\n }\n ],\n \"nextPageToken\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "27c92370-339b-4303-8e37-e120697723b5", "documentation": "Creates a new FHIR store within the parent dataset.", "method": "post", "endpoint": "v1beta1/:parent/fhirStores", "responses": [ { "uuid": "15c7c283-08a0-40f0-ac64-b0f23c551e64", "body": "{\n \"complexDataTypeReferenceParsing\": \"{{oneOf (array 'COMPLEX_DATA_TYPE_REFERENCE_PARSING_UNSPECIFIED' 'DISABLED' 'ENABLED')}}\",\n \"defaultSearchHandlingStrict\": {{faker 'datatype.boolean'}},\n \"disableReferentialIntegrity\": {{faker 'datatype.boolean'}},\n \"disableResourceVersioning\": {{faker 'datatype.boolean'}},\n \"enableUpdateCreate\": {{faker 'datatype.boolean'}},\n \"labels\": {},\n \"name\": \"\",\n \"notificationConfig\": {\n \"pubsubTopic\": \"\",\n \"sendForBulkImport\": {{faker 'datatype.boolean'}}\n },\n \"notificationConfigs\": [\n {\n \"pubsubTopic\": \"\",\n \"sendFullResource\": {{faker 'datatype.boolean'}}\n }\n ],\n \"searchConfig\": {\n \"searchParameters\": [\n {\n \"canonicalUrl\": \"\",\n \"parameter\": \"\"\n }\n ]\n },\n \"streamConfigs\": [\n {\n \"bigqueryDestination\": {\n \"datasetUri\": \"\",\n \"force\": {{faker 'datatype.boolean'}},\n \"schemaConfig\": {\n \"recursiveStructureDepth\": \"\",\n \"schemaType\": \"{{oneOf (array 'SCHEMA_TYPE_UNSPECIFIED' 'LOSSLESS' 'ANALYTICS' 'ANALYTICS_V2')}}\"\n },\n \"writeDisposition\": \"{{oneOf (array 'WRITE_DISPOSITION_UNSPECIFIED' 'WRITE_EMPTY' 'WRITE_TRUNCATE' 'WRITE_APPEND')}}\"\n },\n \"deidentifiedStoreDestination\": {\n \"config\": {\n \"annotation\": {\n \"annotationStoreName\": \"\",\n \"storeQuote\": {{faker 'datatype.boolean'}}\n },\n \"dicom\": {\n \"filterProfile\": \"{{oneOf (array 'TAG_FILTER_PROFILE_UNSPECIFIED' 'MINIMAL_KEEP_LIST_PROFILE' 'ATTRIBUTE_CONFIDENTIALITY_BASIC_PROFILE' 'KEEP_ALL_PROFILE' 'DEIDENTIFY_TAG_CONTENTS')}}\",\n \"keepList\": {\n \"tags\": [\n \"\"\n ]\n },\n \"removeList\": {\n \"tags\": [\n \"\"\n ]\n },\n \"skipIdRedaction\": {{faker 'datatype.boolean'}}\n },\n \"fhir\": {\n \"defaultKeepExtensions\": {{faker 'datatype.boolean'}},\n \"fieldMetadataList\": [\n {\n \"action\": \"{{oneOf (array 'ACTION_UNSPECIFIED' 'TRANSFORM' 'INSPECT_AND_TRANSFORM' 'DO_NOT_TRANSFORM')}}\",\n \"paths\": [\n \"\"\n ]\n }\n ]\n },\n \"image\": {\n \"textRedactionMode\": \"{{oneOf (array 'TEXT_REDACTION_MODE_UNSPECIFIED' 'REDACT_ALL_TEXT' 'REDACT_SENSITIVE_TEXT' 'REDACT_NO_TEXT')}}\"\n },\n \"operationMetadata\": {\n \"fhirOutput\": {\n \"fhirStore\": \"\"\n }\n },\n \"text\": {\n \"transformations\": [\n {\n \"characterMaskConfig\": {\n \"maskingCharacter\": \"\"\n },\n \"cryptoHashConfig\": {\n \"cryptoKey\": \"\",\n \"kmsWrapped\": {\n \"cryptoKey\": \"\",\n \"wrappedKey\": \"\"\n }\n },\n \"dateShiftConfig\": {\n \"cryptoKey\": \"\",\n \"kmsWrapped\": {\n \"cryptoKey\": \"\",\n \"wrappedKey\": \"\"\n }\n },\n \"infoTypes\": [\n \"\"\n ],\n \"redactConfig\": {},\n \"replaceWithInfoTypeConfig\": {}\n }\n ]\n }\n },\n \"store\": \"\"\n },\n \"resourceTypes\": [\n \"\"\n ]\n }\n ],\n \"validationConfig\": {\n \"disableFhirpathValidation\": {{faker 'datatype.boolean'}},\n \"disableProfileValidation\": {{faker 'datatype.boolean'}},\n \"disableReferenceTypeValidation\": {{faker 'datatype.boolean'}},\n \"disableRequiredFieldValidation\": {{faker 'datatype.boolean'}},\n \"enabledImplementationGuides\": [\n \"\"\n ]\n },\n \"version\": \"{{oneOf (array 'VERSION_UNSPECIFIED' 'DSTU2' 'STU3' 'R4')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b67dca9b-437c-46da-8492-3c2d4984bfcd", "documentation": "Lists the HL7v2 stores in the given dataset.", "method": "get", "endpoint": "v1beta1/:parent/hl7V2Stores", "responses": [ { "uuid": "1d10945e-8cfa-46d4-9b22-353713221907", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "91891b2a-5776-41bd-a671-0a04361eeed6", "documentation": "Creates a new HL7v2 store within the parent dataset.", "method": "post", "endpoint": "v1beta1/:parent/hl7V2Stores", "responses": [ { "uuid": "bb9a441b-f1f0-4456-be8f-eb36781f2447", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f1195b76-fa88-4f16-9e4f-6d5dc67d10b3", "documentation": "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.", "method": "get", "endpoint": "v1beta1/:parent/messages", "responses": [ { "uuid": "d9d0c5c7-6204-41b6-81e6-d5355a502ad2", "body": "{\n \"hl7V2Messages\": [\n {\n \"createTime\": \"\",\n \"data\": \"\",\n \"labels\": {},\n \"messageType\": \"\",\n \"name\": \"\",\n \"parsedData\": {\n \"segments\": [\n {\n \"fields\": {},\n \"segmentId\": \"\",\n \"setId\": \"\"\n }\n ]\n },\n \"patientIds\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"schematizedData\": {\n \"data\": \"\",\n \"error\": \"\"\n },\n \"sendFacility\": \"\",\n \"sendTime\": \"\"\n }\n ],\n \"nextPageToken\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b6b6199f-5d6d-4531-87ee-2d080db325a5", "documentation": "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.", "method": "post", "endpoint": "v1beta1/:parent/messages", "responses": [ { "uuid": "d468b983-94ac-4dbe-a752-2b6ade24bdf3", "body": "{\n \"createTime\": \"\",\n \"data\": \"\",\n \"labels\": {},\n \"messageType\": \"\",\n \"name\": \"\",\n \"parsedData\": {\n \"segments\": [\n {\n \"fields\": {},\n \"segmentId\": \"\",\n \"setId\": \"\"\n }\n ]\n },\n \"patientIds\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"schematizedData\": {\n \"data\": \"\",\n \"error\": \"\"\n },\n \"sendFacility\": \"\",\n \"sendTime\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "87cdf59d-c498-4d85-907c-ca84fbdabe1c", "documentation": "Gets multiple messages in the given HL7v2 store.", "method": "get", "endpoint": "v1beta1/:parent/messages:batchGet", "responses": [ { "uuid": "77cc87fc-032c-4e4e-9655-fb2a10429cdf", "body": "{\n \"messages\": [\n {\n \"createTime\": \"\",\n \"data\": \"\",\n \"labels\": {},\n \"messageType\": \"\",\n \"name\": \"\",\n \"parsedData\": {\n \"segments\": [\n {\n \"fields\": {},\n \"segmentId\": \"\",\n \"setId\": \"\"\n }\n ]\n },\n \"patientIds\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"schematizedData\": {\n \"data\": \"\",\n \"error\": \"\"\n },\n \"sendFacility\": \"\",\n \"sendTime\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "acfc9fa9-9692-4700-9110-c08436bbb170", "documentation": "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.", "method": "post", "endpoint": "v1beta1/:parent/messages:ingest", "responses": [ { "uuid": "d53b43da-3489-495b-9853-1bbdff7a7f3e", "body": "{\n \"hl7Ack\": \"\",\n \"message\": {\n \"createTime\": \"\",\n \"data\": \"\",\n \"labels\": {},\n \"messageType\": \"\",\n \"name\": \"\",\n \"parsedData\": {\n \"segments\": [\n {\n \"fields\": {},\n \"segmentId\": \"\",\n \"setId\": \"\"\n }\n ]\n },\n \"patientIds\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"schematizedData\": {\n \"data\": \"\",\n \"error\": \"\"\n },\n \"sendFacility\": \"\",\n \"sendTime\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "4d864013-b83f-4d73-9ac0-75efb7627704", "documentation": "Lists the User data mappings in the specified consent store.", "method": "get", "endpoint": "v1beta1/:parent/userDataMappings", "responses": [ { "uuid": "3f3b7fd1-08b9-4d77-9e4f-af140dfadeee", "body": "{\n \"nextPageToken\": \"\",\n \"userDataMappings\": [\n {\n \"archiveTime\": \"\",\n \"archived\": {{faker 'datatype.boolean'}},\n \"dataId\": \"\",\n \"name\": \"\",\n \"resourceAttributes\": [\n {\n \"attributeDefinitionId\": \"\",\n \"values\": [\n \"\"\n ]\n }\n ],\n \"userId\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "df0e3076-9c57-416a-9d56-2edc4fd2c12e", "documentation": "Creates a new User data mapping in the parent consent store.", "method": "post", "endpoint": "v1beta1/:parent/userDataMappings", "responses": [ { "uuid": "5bb0ef81-3163-4a25-aaf7-1d8e4e93a003", "body": "{\n \"archiveTime\": \"\",\n \"archived\": {{faker 'datatype.boolean'}},\n \"dataId\": \"\",\n \"name\": \"\",\n \"resourceAttributes\": [\n {\n \"attributeDefinitionId\": \"\",\n \"values\": [\n \"\"\n ]\n }\n ],\n \"userId\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "bbf917f7-0664-4e74-a88f-996847f14c0a", "documentation": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", "method": "get", "endpoint": "v1beta1/:resource:getIamPolicy", "responses": [ { "uuid": "cae8e6eb-506e-4fbf-8a4c-4efd58532fb9", "body": "{\n \"auditConfigs\": [\n {\n \"auditLogConfigs\": [\n {\n \"exemptedMembers\": [\n \"\"\n ],\n \"logType\": \"{{oneOf (array 'LOG_TYPE_UNSPECIFIED' 'ADMIN_READ' 'DATA_WRITE' 'DATA_READ')}}\"\n }\n ],\n \"service\": \"\"\n }\n ],\n \"bindings\": [\n {\n \"condition\": {\n \"description\": \"\",\n \"expression\": \"\",\n \"location\": \"\",\n \"title\": \"\"\n },\n \"members\": [\n \"\"\n ],\n \"role\": \"\"\n }\n ],\n \"etag\": \"\",\n \"version\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "77409e10-75d1-4455-9f1e-caab1e046002", "documentation": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "method": "post", "endpoint": "v1beta1/:resource:setIamPolicy", "responses": [ { "uuid": "a8849873-16f7-4854-a2a6-d390ce974555", "body": "{\n \"auditConfigs\": [\n {\n \"auditLogConfigs\": [\n {\n \"exemptedMembers\": [\n \"\"\n ],\n \"logType\": \"{{oneOf (array 'LOG_TYPE_UNSPECIFIED' 'ADMIN_READ' 'DATA_WRITE' 'DATA_READ')}}\"\n }\n ],\n \"service\": \"\"\n }\n ],\n \"bindings\": [\n {\n \"condition\": {\n \"description\": \"\",\n \"expression\": \"\",\n \"location\": \"\",\n \"title\": \"\"\n },\n \"members\": [\n \"\"\n ],\n \"role\": \"\"\n }\n ],\n \"etag\": \"\",\n \"version\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "35503c05-da8d-412e-bade-010b011859b9", "documentation": "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.", "method": "post", "endpoint": "v1beta1/:resource:testIamPermissions", "responses": [ { "uuid": "2def2fab-a42a-4ac8-8144-ba238f05e281", "body": "{\n \"permissions\": [\n \"\"\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d5b59203-2969-4ea1-8bcb-221a743f7c5d", "documentation": "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).", "method": "post", "endpoint": "v1beta1/:sourceDataset:deidentify", "responses": [ { "uuid": "9dba0db4-ff8c-467f-9089-0495fcc7497f", "body": "{\n \"done\": {{faker 'datatype.boolean'}},\n \"error\": {\n \"code\": {{faker 'number.int' max=99999}},\n \"details\": [\n {}\n ],\n \"message\": \"\"\n },\n \"metadata\": {},\n \"name\": \"\",\n \"response\": {}\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c08c1598-71bb-4c2b-8054-383a8ad934b5", "documentation": "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).", "method": "post", "endpoint": "v1beta1/:sourceStore:deidentify", "responses": [ { "uuid": "19bfe2c3-5e2a-460d-9753-5445d5c4b889", "body": "{\n \"done\": {{faker 'datatype.boolean'}},\n \"error\": {\n \"code\": {{faker 'number.int' max=99999}},\n \"details\": [\n {}\n ],\n \"message\": \"\"\n },\n \"metadata\": {},\n \"name\": \"\",\n \"response\": {}\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" } ], "proxyMode": false, "proxyHost": "", "proxyRemovePrefix": false, "tlsOptions": { "enabled": false, "type": "CERT", "pfxPath": "", "certPath": "", "keyPath": "", "caPath": "", "passphrase": "" }, "cors": true, "headers": [], "proxyReqHeaders": [{ "key": "", "value": "" }], "proxyResHeaders": [{ "key": "", "value": "" }], "data": [], "folders": [], "rootChildren": [ { "type": "route", "uuid": "da7c5408-2ae4-4dda-ac3d-e811586d00ae" }, { "type": "route", "uuid": "68c15145-28a8-42c6-af97-48cd7f9c90fd" }, { "type": "route", "uuid": "c6372283-cf75-4f28-9b8f-69b1eed8c317" }, { "type": "route", "uuid": "7d858fe7-8686-4a54-908a-3ac2270d5d3f" }, { "type": "route", "uuid": "5fbacd8d-1dab-4b5a-aeaa-3b448aa6f44c" }, { "type": "route", "uuid": "0fefbed6-13ff-4685-a932-e044b5c3fbfa" }, { "type": "route", "uuid": "e8d82c95-b57e-4c73-b63a-a3e8c59a80e7" }, { "type": "route", "uuid": "daac5b4f-f62b-4c47-bf02-6935da5159ab" }, { "type": "route", "uuid": "f2f3277a-aec9-4497-aebb-ae51c67c2d11" }, { "type": "route", "uuid": "bbcf78ca-f7bd-4cac-b154-f0e300051add" }, { "type": "route", "uuid": "93db756e-6eaf-4704-9c1d-c65d5a9aeffb" }, { "type": "route", "uuid": "ea559d40-f267-4e56-861a-4ea13775e4ed" }, { "type": "route", "uuid": "2ab8e7f1-6186-4efe-ac8c-462c836da3af" }, { "type": "route", "uuid": "14852c49-81cf-4b77-a757-3e399618b817" }, { "type": "route", "uuid": "7479c7e0-7ff8-4c16-a1a1-e55ba0412f67" }, { "type": "route", "uuid": "e9474a6b-0737-4d9f-af2e-f688e3ec4d47" }, { "type": "route", "uuid": "b0e86882-4221-4e46-bf78-30c1f94b7576" }, { "type": "route", "uuid": "2ac81ff4-e1ec-4803-b69a-aaab0be79b98" }, { "type": "route", "uuid": "1b2e153a-4f0f-4593-bfca-a5bce4175ba3" }, { "type": "route", "uuid": "66253272-c6d0-4108-a863-e46f58699ed5" }, { "type": "route", "uuid": "a3c10234-2934-457e-980b-75ecf3a93c96" }, { "type": "route", "uuid": "8dcc5879-a34f-4c7d-94aa-c395cea4df22" }, { "type": "route", "uuid": "eb52377a-e4b5-4b20-a4c4-8fa86297b3fe" }, { "type": "route", "uuid": "7b85b3cd-6f1b-4c67-ad8b-b400f2b40b7c" }, { "type": "route", "uuid": "1b6d6612-f556-4664-8ef9-99ef5d5c0c70" }, { "type": "route", "uuid": "56e5f384-91ed-4444-b1a8-9665802d6af1" }, { "type": "route", "uuid": "701b3a9a-b0ff-499b-adcb-c698f59d2b08" }, { "type": "route", "uuid": "67459827-899b-4854-891e-730a2b341b86" }, { "type": "route", "uuid": "2fb558f3-6669-49d6-9fd2-051667b29e39" }, { "type": "route", "uuid": "b6cf84af-f712-41af-be14-7c98c5af67af" }, { "type": "route", "uuid": "9472bd77-05b3-4006-b371-81bc92a67d18" }, { "type": "route", "uuid": "487f2b0c-ce4a-4c55-8b1e-cec67fa2e9a8" }, { "type": "route", "uuid": "1a5c61ea-9f2e-444a-959f-e2b075d5bf6d" }, { "type": "route", "uuid": "7d523a4a-ac36-4991-951e-c84b7753e097" }, { "type": "route", "uuid": "2f8e58ba-9935-4629-a231-f8871c8355c7" }, { "type": "route", "uuid": "1c121019-9ab2-40b3-a79d-89cdcce128dd" }, { "type": "route", "uuid": "d98fd08f-0550-44f1-b40d-105cea0e01f6" }, { "type": "route", "uuid": "4c219300-685c-420f-bc53-86b05ccd05e7" }, { "type": "route", "uuid": "d1bfecb1-3bbe-4c60-bd1e-9b582442d5d5" }, { "type": "route", "uuid": "ebc17540-119b-4f26-bbf2-73f9f20da98a" }, { "type": "route", "uuid": "66afa476-1e93-4e0d-84e8-349600a05d2f" }, { "type": "route", "uuid": "3ef4a153-2f69-4b80-bd41-6ddd883fbfb1" }, { "type": "route", "uuid": "7d108b43-2f47-463f-959e-77b5b4f3dbd7" }, { "type": "route", "uuid": "3290fc9e-2d1a-4781-846b-0c5c2930c95f" }, { "type": "route", "uuid": "7912fda0-d617-4e5e-bf18-377767833efa" }, { "type": "route", "uuid": "15b32189-914a-4c89-a1e2-5fc5e49265a2" }, { "type": "route", "uuid": "fb23e0ef-729e-4836-a73c-17ff36aa97da" }, { "type": "route", "uuid": "e8178bb7-7dfb-4a6a-bb05-ffd101cab62f" }, { "type": "route", "uuid": "133a2e7e-03a5-4254-9669-675928f14252" }, { "type": "route", "uuid": "c39e80df-661d-4d52-9e25-256c24ce9448" }, { "type": "route", "uuid": "426728e9-3888-437a-b69a-12177303a0eb" }, { "type": "route", "uuid": "7c77d32e-e566-40c7-83f9-8e304fcc5070" }, { "type": "route", "uuid": "8555ba09-fb51-4a09-8e97-54e4673af95f" }, { "type": "route", "uuid": "f6dea82e-55cf-4af8-bb43-90ba93c5f188" }, { "type": "route", "uuid": "1c3d5641-2cc2-4e48-acd4-8cca540e1f5d" }, { "type": "route", "uuid": "f2da3ec5-ec00-4fbc-a428-f1912775fde8" }, { "type": "route", "uuid": "27c92370-339b-4303-8e37-e120697723b5" }, { "type": "route", "uuid": "b67dca9b-437c-46da-8492-3c2d4984bfcd" }, { "type": "route", "uuid": "91891b2a-5776-41bd-a671-0a04361eeed6" }, { "type": "route", "uuid": "f1195b76-fa88-4f16-9e4f-6d5dc67d10b3" }, { "type": "route", "uuid": "b6b6199f-5d6d-4531-87ee-2d080db325a5" }, { "type": "route", "uuid": "87cdf59d-c498-4d85-907c-ca84fbdabe1c" }, { "type": "route", "uuid": "acfc9fa9-9692-4700-9110-c08436bbb170" }, { "type": "route", "uuid": "4d864013-b83f-4d73-9ac0-75efb7627704" }, { "type": "route", "uuid": "df0e3076-9c57-416a-9d56-2edc4fd2c12e" }, { "type": "route", "uuid": "bbf917f7-0664-4e74-a88f-996847f14c0a" }, { "type": "route", "uuid": "77409e10-75d1-4455-9f1e-caab1e046002" }, { "type": "route", "uuid": "35503c05-da8d-412e-bade-010b011859b9" }, { "type": "route", "uuid": "d5b59203-2969-4ea1-8bcb-221a743f7c5d" }, { "type": "route", "uuid": "c08c1598-71bb-4c2b-8054-383a8ad934b5" } ] }