Skip to content

Commit 5d56c94

Browse files
yoshi-automationsofisl
authored andcommitted
feat(healthcare): update the API
#### healthcare:v1beta1 The following keys were added: - schemas.FhirNotificationConfig.properties.sendPreviousResourceOnDelete.description - schemas.FhirNotificationConfig.properties.sendPreviousResourceOnDelete.type The following keys were changed: - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.Resource-incoming-references.description - schemas.FhirStore.properties.notificationConfig.description #### healthcare:v1 The following keys were added: - schemas.FhirNotificationConfig.description - schemas.FhirNotificationConfig.id - schemas.FhirNotificationConfig.properties.pubsubTopic.description - schemas.FhirNotificationConfig.properties.pubsubTopic.type - schemas.FhirNotificationConfig.properties.sendFullResource.description - schemas.FhirNotificationConfig.properties.sendFullResource.type - schemas.FhirNotificationConfig.properties.sendPreviousResourceOnDelete.description - schemas.FhirNotificationConfig.properties.sendPreviousResourceOnDelete.type - schemas.FhirNotificationConfig.type - schemas.FhirStore.properties.notificationConfigs.description - schemas.FhirStore.properties.notificationConfigs.items.$ref - schemas.FhirStore.properties.notificationConfigs.type The following keys were changed: - schemas.FhirStore.properties.notificationConfig.description
1 parent 6ff8ff8 commit 5d56c94

File tree

4 files changed

+68
-8
lines changed

4 files changed

+68
-8
lines changed

discovery/healthcare-v1.json

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4078,7 +4078,7 @@
40784078
}
40794079
}
40804080
},
4081-
"revision": "20230321",
4081+
"revision": "20230412",
40824082
"rootUrl": "https://healthcare.googleapis.com/",
40834083
"schemas": {
40844084
"ActivateConsentRequest": {
@@ -5107,6 +5107,25 @@
51075107
},
51085108
"type": "object"
51095109
},
5110+
"FhirNotificationConfig": {
5111+
"description": "Contains the configuration for FHIR notifications.",
5112+
"id": "FhirNotificationConfig",
5113+
"properties": {
5114+
"pubsubTopic": {
5115+
"description": "The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. The notification is a `PubsubMessage` with the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time when the message was published. Note that notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. The Cloud Healthcare API service account, [email protected], must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail (https://cloud.google.com/healthcare-api/docs/permissions-healthcare-api-gcp-products#dicom_fhir_and_hl7v2_store_cloud_pubsub_permissions). If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare-api/docs/how-tos/logging).",
5116+
"type": "string"
5117+
},
5118+
"sendFullResource": {
5119+
"description": "Whether to send full FHIR resource to this Pub/Sub topic.",
5120+
"type": "boolean"
5121+
},
5122+
"sendPreviousResourceOnDelete": {
5123+
"description": "Whether to send full FHIR resource to this pubsub topic for deleting FHIR resource. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the \"payloadType\" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation.",
5124+
"type": "boolean"
5125+
}
5126+
},
5127+
"type": "object"
5128+
},
51105129
"FhirStore": {
51115130
"description": "Represents a FHIR store.",
51125131
"id": "FhirStore",
@@ -5154,7 +5173,14 @@
51545173
},
51555174
"notificationConfig": {
51565175
"$ref": "NotificationConfig",
5157-
"description": "If non-empty, publish all resource modifications of this FHIR store to this destination. The Pub/Sub message attributes contain a map with a string describing the action that has triggered the notification. For example, \"action\":\"CreateResource\"."
5176+
"description": "Deprecated. Use `notification_configs` instead. If non-empty, publish all resource modifications of this FHIR store to this destination. The Pub/Sub message attributes contain a map with a string describing the action that has triggered the notification. For example, \"action\":\"CreateResource\"."
5177+
},
5178+
"notificationConfigs": {
5179+
"description": "Specifies where and whether to send notifications upon changes to a FHIR store.",
5180+
"items": {
5181+
"$ref": "FhirNotificationConfig"
5182+
},
5183+
"type": "array"
51585184
},
51595185
"streamConfigs": {
51605186
"description": "A list of streaming configs that configure the destinations of streaming export for every resource mutation in this FHIR store. Each store is allowed to have up to 10 streaming configs. After a new config is added, the next resource mutation is streamed to the new location in addition to the existing ones. When a location is removed from the list, the server stops streaming to that location. Before adding a new config, you must add the required [`bigquery.dataEditor`](https://cloud.google.com/bigquery/docs/access-control#bigquery.dataEditor) role to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/iam/docs/service-accounts). Some lag (typically on the order of dozens of seconds) is expected before the results show up in the streaming destination.",

discovery/healthcare-v1beta1.json

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3655,7 +3655,7 @@
36553655
]
36563656
},
36573657
"Resource-incoming-references": {
3658-
"description": "Gets all incoming references to a given target FHIR resource. Can also get all incoming references when the target resource does not exist, for example, if the target has been deleted. On success, the response body contains a Bundle with type `searchset`, where each entry in the Bundle contains the full content of the resource. If the operation fails, an `OperationOutcome` is returned describing the failure. If the request cannot be mapped to a valid API method on a FHIR store, a generic Google Cloud error might be returned instead.",
3658+
"description": "Lists all the resources that directly refer to the given target FHIR resource. Can also support the case when the target resource doesn't exist, for example, if the target has been deleted. On success, the response body contains a Bundle with type `searchset`, where each entry in the Bundle contains the full content of the resource. If the operation fails, an `OperationOutcome` is returned describing the failure. If the request cannot be mapped to a valid API method on a FHIR store, a generic Google Cloud error might be returned instead.",
36593659
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/$references",
36603660
"httpMethod": "GET",
36613661
"id": "healthcare.projects.locations.datasets.fhirStores.fhir.Resource-incoming-references",
@@ -4941,7 +4941,7 @@
49414941
}
49424942
}
49434943
},
4944-
"revision": "20230321",
4944+
"revision": "20230412",
49454945
"rootUrl": "https://healthcare.googleapis.com/",
49464946
"schemas": {
49474947
"Action": {
@@ -6388,6 +6388,10 @@
63886388
"sendFullResource": {
63896389
"description": "Whether to send full FHIR resource to this Pub/Sub topic for Create and Update operation. Note that setting this to true does not guarantee that all resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the \"payloadType\" label from a Pub/Sub message to determine whether it needs to fetch the full resource as a separate operation.",
63906390
"type": "boolean"
6391+
},
6392+
"sendPreviousResourceOnDelete": {
6393+
"description": "Whether to send full FHIR resource to this pubsub topic for deleting FHIR resource. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the \"payloadType\" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation.",
6394+
"type": "boolean"
63916395
}
63926396
},
63936397
"type": "object"
@@ -6450,7 +6454,7 @@
64506454
},
64516455
"notificationConfig": {
64526456
"$ref": "NotificationConfig",
6453-
"description": "If non-empty, publish all resource modifications of this FHIR store to this destination. The Pub/Sub message attributes contain a map with a string describing the action that has triggered the notification. For example, \"action\":\"CreateResource\". Deprecated. Use `notification_configs` instead."
6457+
"description": "Deprecated. Use `notification_configs` instead. If non-empty, publish all resource modifications of this FHIR store to this destination. The Pub/Sub message attributes contain a map with a string describing the action that has triggered the notification. For example, \"action\":\"CreateResource\"."
64546458
},
64556459
"notificationConfigs": {
64566460
"description": "Specifies where and whether to send notifications upon changes to a Fhir store.",

src/apis/healthcare/v1.ts

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -865,6 +865,23 @@ export namespace healthcare_v1 {
865865
*/
866866
resources?: Schema$Resources;
867867
}
868+
/**
869+
* Contains the configuration for FHIR notifications.
870+
*/
871+
export interface Schema$FhirNotificationConfig {
872+
/**
873+
* The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. The notification is a `PubsubMessage` with the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time when the message was published. Note that notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. The Cloud Healthcare API service account, [email protected], must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail (https://cloud.google.com/healthcare-api/docs/permissions-healthcare-api-gcp-products#dicom_fhir_and_hl7v2_store_cloud_pubsub_permissions). If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare-api/docs/how-tos/logging).
874+
*/
875+
pubsubTopic?: string | null;
876+
/**
877+
* Whether to send full FHIR resource to this Pub/Sub topic.
878+
*/
879+
sendFullResource?: boolean | null;
880+
/**
881+
* Whether to send full FHIR resource to this pubsub topic for deleting FHIR resource. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation.
882+
*/
883+
sendPreviousResourceOnDelete?: boolean | null;
884+
}
868885
/**
869886
* Represents a FHIR store.
870887
*/
@@ -898,9 +915,13 @@ export namespace healthcare_v1 {
898915
*/
899916
name?: string | null;
900917
/**
901-
* If non-empty, publish all resource modifications of this FHIR store to this destination. The Pub/Sub message attributes contain a map with a string describing the action that has triggered the notification. For example, "action":"CreateResource".
918+
* Deprecated. Use `notification_configs` instead. If non-empty, publish all resource modifications of this FHIR store to this destination. The Pub/Sub message attributes contain a map with a string describing the action that has triggered the notification. For example, "action":"CreateResource".
902919
*/
903920
notificationConfig?: Schema$NotificationConfig;
921+
/**
922+
* Specifies where and whether to send notifications upon changes to a FHIR store.
923+
*/
924+
notificationConfigs?: Schema$FhirNotificationConfig[];
904925
/**
905926
* A list of streaming configs that configure the destinations of streaming export for every resource mutation in this FHIR store. Each store is allowed to have up to 10 streaming configs. After a new config is added, the next resource mutation is streamed to the new location in addition to the existing ones. When a location is removed from the list, the server stops streaming to that location. Before adding a new config, you must add the required [`bigquery.dataEditor`](https://cloud.google.com/bigquery/docs/access-control#bigquery.dataEditor) role to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/iam/docs/service-accounts). Some lag (typically on the order of dozens of seconds) is expected before the results show up in the streaming destination.
906927
*/
@@ -14278,6 +14299,7 @@ export namespace healthcare_v1 {
1427814299
* // "labels": {},
1427914300
* // "name": "my_name",
1428014301
* // "notificationConfig": {},
14302+
* // "notificationConfigs": [],
1428114303
* // "streamConfigs": [],
1428214304
* // "validationConfig": {},
1428314305
* // "version": "my_version"
@@ -14296,6 +14318,7 @@ export namespace healthcare_v1 {
1429614318
* // "labels": {},
1429714319
* // "name": "my_name",
1429814320
* // "notificationConfig": {},
14321+
* // "notificationConfigs": [],
1429914322
* // "streamConfigs": [],
1430014323
* // "validationConfig": {},
1430114324
* // "version": "my_version"
@@ -14851,6 +14874,7 @@ export namespace healthcare_v1 {
1485114874
* // "labels": {},
1485214875
* // "name": "my_name",
1485314876
* // "notificationConfig": {},
14877+
* // "notificationConfigs": [],
1485414878
* // "streamConfigs": [],
1485514879
* // "validationConfig": {},
1485614880
* // "version": "my_version"
@@ -15545,6 +15569,7 @@ export namespace healthcare_v1 {
1554515569
* // "labels": {},
1554615570
* // "name": "my_name",
1554715571
* // "notificationConfig": {},
15572+
* // "notificationConfigs": [],
1554815573
* // "streamConfigs": [],
1554915574
* // "validationConfig": {},
1555015575
* // "version": "my_version"
@@ -15563,6 +15588,7 @@ export namespace healthcare_v1 {
1556315588
* // "labels": {},
1556415589
* // "name": "my_name",
1556515590
* // "notificationConfig": {},
15591+
* // "notificationConfigs": [],
1556615592
* // "streamConfigs": [],
1556715593
* // "validationConfig": {},
1556815594
* // "version": "my_version"

src/apis/healthcare/v1beta1.ts

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1170,6 +1170,10 @@ export namespace healthcare_v1beta1 {
11701170
* Whether to send full FHIR resource to this Pub/Sub topic for Create and Update operation. Note that setting this to true does not guarantee that all resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full resource as a separate operation.
11711171
*/
11721172
sendFullResource?: boolean | null;
1173+
/**
1174+
* Whether to send full FHIR resource to this pubsub topic for deleting FHIR resource. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation.
1175+
*/
1176+
sendPreviousResourceOnDelete?: boolean | null;
11731177
}
11741178
/**
11751179
* Details about the FHIR store to write the output to.
@@ -1213,7 +1217,7 @@ export namespace healthcare_v1beta1 {
12131217
*/
12141218
name?: string | null;
12151219
/**
1216-
* If non-empty, publish all resource modifications of this FHIR store to this destination. The Pub/Sub message attributes contain a map with a string describing the action that has triggered the notification. For example, "action":"CreateResource". Deprecated. Use `notification_configs` instead.
1220+
* Deprecated. Use `notification_configs` instead. If non-empty, publish all resource modifications of this FHIR store to this destination. The Pub/Sub message attributes contain a map with a string describing the action that has triggered the notification. For example, "action":"CreateResource".
12171221
*/
12181222
notificationConfig?: Schema$NotificationConfig;
12191223
/**
@@ -21374,7 +21378,7 @@ export namespace healthcare_v1beta1 {
2137421378
}
2137521379

2137621380
/**
21377-
* Gets all incoming references to a given target FHIR resource. Can also get all incoming references when the target resource does not exist, for example, if the target has been deleted. On success, the response body contains a Bundle with type `searchset`, where each entry in the Bundle contains the full content of the resource. If the operation fails, an `OperationOutcome` is returned describing the failure. If the request cannot be mapped to a valid API method on a FHIR store, a generic Google Cloud error might be returned instead.
21381+
* Lists all the resources that directly refer to the given target FHIR resource. Can also support the case when the target resource doesn't exist, for example, if the target has been deleted. On success, the response body contains a Bundle with type `searchset`, where each entry in the Bundle contains the full content of the resource. If the operation fails, an `OperationOutcome` is returned describing the failure. If the request cannot be mapped to a valid API method on a FHIR store, a generic Google Cloud error might be returned instead.
2137821382
* @example
2137921383
* ```js
2138021384
* // Before running the sample:

0 commit comments

Comments
 (0)