Skip to content

Commit 65ecc39

Browse files
Merge pull request #264584 from shellyhaverkamp/smh-events-FAQ-TOC
FAQ + TOC updates
2 parents 2018322 + 8247292 commit 65ecc39

10 files changed

+91
-114
lines changed
Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,56 @@
11
---
2-
title: How to disable events and delete events enabled workspaces - Azure Health Data Services
3-
description: Learn how to disable events and delete events enabled workspaces.
2+
title: Disable events for the FHIR or DICOM service in Azure Health Data Services
3+
description: Disable events for the FHIR or DICOM service in Azure Health Services by deleting an event subscription. Learn why and how to stop sending notifications from your data and resources.
44
services: healthcare-apis
55
author: msjasteppe
66
ms.service: healthcare-apis
7-
ms.subservice: fhir
7+
ms.subservice: events
88
ms.topic: how-to
9-
ms.date: 09/26/2023
9+
ms.date: 01/31/2024
1010
ms.author: jasteppe
1111
---
1212

13-
# How to disable events and delete event enabled workspaces
13+
# Disable events
1414

15-
> [!NOTE]
16-
> [Fast Healthcare Interoperability Resources (FHIR®)](https://www.hl7.org/fhir/) is an open healthcare specification.
15+
**Applies to:** [!INCLUDE [Yes icon](../includes/applies-to.md)][!INCLUDE [FHIR service](../includes/fhir-service.md)], [!INCLUDE [DICOM service](../includes/DICOM-service.md)]
1716

18-
In this article, learn how to disable events and delete events enabled workspaces.
17+
Events in Azure Health Services allow you to monitor and respond to changes in your data and resources. By creating an event subscription, you can specify the conditions and actions for sending notifications to various endpoints.
1918

20-
## Disable events
19+
However, there may be situations where you want to temporarily or permanently stop receiving notifications from an event subscription. For example, you might want to pause notifications during maintenance or testing, or delete the event subscription if you no longer need it.
2120

22-
To disable events from sending event messages for a single **Event Subscription**, the **Event Subscription** must be deleted.
21+
To disable events from sending notifications for an **Event Subscription**, you need to delete the subscription.
2322

24-
1. Select the **Event Subscription** to be deleted. In this example, we're selecting an Event Subscription named **fhir-events**.
23+
1. In the Azure portal on the left pane, select **Events**.
2524

26-
:::image type="content" source="media/disable-delete-workspaces/select-event-subscription.png" alt-text="Screenshot of Events Subscriptions and select event subscription to be deleted." lightbox="media/disable-delete-workspaces/select-event-subscription.png":::
25+
1. Select **Event Subscriptions**.
2726

28-
2. Select **Delete** and confirm the **Event Subscription** deletion.
27+
1. Select the **Event Subscription** you want to disable notifications for. In the example, the event subscription is named **azuredocsdemo-fhir-events-subscription**.
2928

30-
:::image type="content" source="media/disable-delete-workspaces/select-subscription-delete.png" alt-text="Screenshot of events subscriptions and select delete and confirm the event subscription to be deleted." lightbox="media/disable-delete-workspaces/select-subscription-delete.png":::
29+
:::image type="content" source="media/disable-delete-workspaces/select-event-subscription.png" alt-text="Screenshot showing selection of event subscription to be deleted." lightbox="media/disable-delete-workspaces/select-event-subscription.png":::
3130

32-
3. If you have multiple **Event Subscriptions**, follow the steps to delete the **Event Subscriptions** so that no **Event Subscriptions** remain.
31+
1. Choose **Delete**.
3332

34-
:::image type="content" source="media/disable-delete-workspaces/no-event-subscriptions-found.png" alt-text="Screenshot of Event Subscriptions and delete all event subscriptions to disable events." lightbox="media/disable-delete-workspaces/no-event-subscriptions-found.png":::
33+
:::image type="content" source="media/disable-delete-workspaces/select-subscription-delete-sml.png" alt-text="Screenshot showing confirmation of the event subscription to be deleted." lightbox="media/disable-delete-workspaces/select-subscription-delete-lrg.png":::
3534

36-
> [!NOTE]
37-
> The FHIR service will automatically go into an **Updating** status to disable events when a full delete of **Event Subscriptions** is executed. The FHIR service will remain online while the operation is completing, however, you won't be able to make any further configuration changes to the FHIR service until the updating has completed.
35+
1. If there are multiple event subscriptions, repeat these steps to delete each one until the message **No Event Subscriptions Found** is displayed in the **Name** field.
3836

39-
## Delete events enabled workspaces
37+
:::image type="content" source="media/disable-delete-workspaces/no-event-subscriptions-found-sml.png" alt-text="Screenshot showing deletion of all event subscriptions to disable events." lightbox="media/disable-delete-workspaces/no-event-subscriptions-found-lrg.png":::
4038

41-
To avoid errors and successfully delete events enabled workspaces, follow these steps and in this specific order:
39+
> [!NOTE]
40+
> When you delete all event subscriptions, the FHIR or DICOM service disables events and goes into **Updating** status. The FHIR or DICOM service stays online during the update, but you can’t change the configuration until it completes.
4241
43-
1. Delete all workspace associated child resources (for example: DICOM services, FHIR services, and MedTech services).
44-
2. Delete all workspace associated **Event Subscriptions**.
45-
3. Delete workspace.
42+
## Delete events-enabled workspaces
4643

47-
## Next steps
44+
To delete events-enabled workspaces without errors, do these steps in this exact order:
45+
46+
1. Delete all child resources associated with the workspace (for example, FHIR® services, DICOM® services, and MedTech services).
4847

49-
In this article, you learned how to disable events and delete events enabled workspaces.
48+
1. [Delete all event subscriptions](#disable-events) associated with the workspace.
5049

51-
To learn about how to troubleshoot events, see
50+
1. Delete the workspace.
51+
52+
## Next steps
5253

53-
> [!div class="nextstepaction"]
54-
> [Troubleshoot events](events-troubleshooting-guide.md)
54+
[Troubleshoot events](events-troubleshooting-guide.md)
5555

56-
FHIR® is a registered trademark of Health Level Seven International, registered in the U.S. Trademark Office and is used with their permission.
56+
[!INCLUDE [FHIR and DICOM trademark statement](../includes/healthcare-apis-fhir-dicom-trademark.md)]
Lines changed: 42 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -1,105 +1,94 @@
11
---
2-
title: Frequently asked questions about events - Azure Health Data Services
3-
description: Learn about the frequently asked questions about events.
2+
title: Events FAQ for Azure Health Data Services
3+
description: Get answers to common questions about the events capability in the FHIR and DICOM services in Azure Health Data Services. Find out how events work, what types of events are supported, and how to subscribe to events by using Azure Event Grid.
44
services: healthcare-apis
55
author: msjasteppe
66
ms.service: healthcare-apis
7-
ms.subservice: fhir
7+
ms.subservice: events
88
ms.topic: reference
9-
ms.date: 07/11/2023
9+
ms.date: 01/31/2024
1010
ms.author: jasteppe
1111
---
1212

13-
# Frequently asked questions about events
13+
# Events FAQ
1414

15-
> [!NOTE]
16-
> [Fast Healthcare Interoperability Resources (FHIR®)](https://www.hl7.org/fhir/) is an open healthcare specification.
15+
**Applies to:** [!INCLUDE [Yes icon](../includes/applies-to.md)][!INCLUDE [FHIR service](../includes/fhir-service.md)], [!INCLUDE [DICOM service](../includes/DICOM-service.md)]
1716

18-
## Events: The basics
17+
Events let you subscribe to data changes in the FHIR® or DICOM® service and get notified through Azure Event Grid. You can use events to trigger workflows, automate tasks, send alerts, and more. In this FAQ, you’ll find answers to some common questions about events.
1918

20-
## Can I use events with a different FHIR/DICOM service other than the Azure Health Data Services FHIR/DICOM service?
19+
**Can I use events with a non-Microsoft FHIR or DICOM service?**
2120

22-
No. The Azure Health Data Services events feature only currently supports the Azure Health Data Services FHIR and DICOM services.
21+
No. The Events capability only supports the Azure Health Data Services FHIR and DICOM services.
2322

24-
## What FHIR resource changes does events support?
23+
**What FHIR resource changes are supported by events?**
2524

26-
Events are generated from the following FHIR service types:
25+
Events are generated from these FHIR service types:
2726

28-
* **FhirResourceCreated** - The event emitted after a FHIR resource gets created successfully.
27+
- **FhirResourceCreated**. The event emitted after a FHIR resource is created.
2928

30-
* **FhirResourceUpdated** - The event emitted after a FHIR resource gets updated successfully.
29+
- **FhirResourceUpdated**. The event emitted after a FHIR resource is updated.
3130

32-
* **FhirResourceDeleted** - The event emitted after a FHIR resource gets soft deleted successfully.
31+
- **FhirResourceDeleted**. The event emitted after a FHIR resource is soft deleted.
3332

34-
For more information about the FHIR service delete types, see [FHIR REST API capabilities for Azure Health Data Services FHIR service](../../healthcare-apis/fhir/fhir-rest-api-capabilities.md).
33+
For more information about delete types in the FHIR service, see [FHIR REST API capabilities for Azure Health Data Services](../../healthcare-apis/fhir/fhir-rest-api-capabilities.md).
3534

36-
## Does events support FHIR bundles?
35+
**Does events support FHIR bundles?**
3736

38-
Yes. The events feature is designed to emit notifications of data changes at the FHIR resource level.
37+
Yes. The events capability emits notifications of data changes at the FHIR resource level.
3938

40-
Events support these [FHIR bundle types](http://hl7.org/fhir/R4/valueset-bundle-type.html) in the following ways:
39+
Events support these [FHIR bundle types](http://hl7.org/fhir/R4/valueset-bundle-type.html):
4140

42-
* **Batch**: An event is emitted for each successful data change operation in a bundle. If one of the operations generates an error, no event is emitted for that operation. For example: the batch bundle contains five operations, however, there's an error with one of the operations. Events are emitted for the four successful operations with no event emitted for the operation that generated an error.
41+
- **Batch**. An event is emitted for each successful data change operation in a bundle. If one of the operations generates an error, no event is emitted for that operation. For example: the batch bundle contains five operations, however, there's an error with one of the operations. Events are emitted for the four successful operations with no event emitted for the operation that generated an error.
4342

44-
* **Transaction**: An event is emitted for each successful bundle operation as long as there are no errors. If there are any errors within a transaction bundle, then no events are emitted. For example: the transaction bundle contains five operations, however, there's an error with one of the operations. No events are emitted for that bundle.
43+
- **Transaction**. An event is emitted for each successful bundle operation as long as there are no errors. If there are any errors within a transaction bundle, then no events are emitted. For example: the transaction bundle contains five operations, however, there's an error with one of the operations. No events are emitted for that bundle.
4544

4645
> [!NOTE]
47-
> Events are not sent in the sequence of the data operations in the FHIR bundle.
46+
> Events aren't sent in the sequence of the data operations in the FHIR bundle.
4847
49-
## What DICOM image changes does events support?
48+
**What DICOM image changes does events support?**
5049

5150
Events are generated from the following DICOM service types:
5251

53-
* **DicomImageCreated** - The event emitted after a DICOM image gets created successfully.
52+
- **DicomImageCreated**. The event emitted after a DICOM image is created.
5453

55-
* **DicomImageDeleted** - The event emitted after a DICOM image gets deleted successfully.
54+
- **DicomImageDeleted**. The event emitted after a DICOM image is deleted.
5655

57-
* **DicomImageUpdated** - The event emitted after a DICOM image gets updated successfully.
56+
- **DicomImageUpdated**. The event emitted after a DICOM image is updated. For more information, see [Update DICOM files](../dicom/update-files.md).
5857

59-
## What is the payload of an events message?
58+
**What is the payload of an events message?**
6059

61-
For a detailed description of the events message structure and both required and nonrequired elements, see [Events message structures](events-message-structure.md).
60+
For a description of the events message structure and required and nonrequired elements, see [Events message structures](events-message-structure.md).
6261

63-
## What is the throughput for the events messages?
62+
**What is the throughput for events messages?**
6463

65-
The throughput of the FHIR or DICOM service and the Event Grid govern the throughput of FHIR and DICOM events. When a request made to the FHIR service is successful, it returns a 2xx HTTP status code. It also generates a FHIR resource or DICOM image changing event. The current limitation is 5,000 events/second per workspace for all FHIR or DICOM service instances in the workspace.
64+
The throughput of the FHIR or DICOM service and the Event Grid governs the throughput of FHIR and DICOM events. When a request made to the FHIR service is successful, it returns a 2xx HTTP status code. It also generates a FHIR resource or DICOM image changing event. The current limitation is 5,000 events/second per workspace for all FHIR or DICOM service instances in the workspace.
6665

67-
## How am I charged for using events?
66+
**How am I charged for using events?**
6867

6968
There are no extra charges for using [Azure Health Data Services events](https://azure.microsoft.com/pricing/details/health-data-services/). However, applicable charges for the [Event Grid](https://azure.microsoft.com/pricing/details/event-grid/) are assessed against your Azure subscription.
7069

71-
## How do I subscribe to multiple FHIR and/or DICOM services in the same workspace separately?
70+
**How do I subscribe separately to multiple FHIR or DICOM services in the same workspace?**
7271

73-
You can use the Event Grid filtering feature. There are unique identifiers in the event message payload to differentiate different accounts and workspaces. You can find a global unique identifier for workspace in the `source` field, which is the Azure Resource ID. You can locate the unique FHIR account name in that workspace in the `data.resourceFhirAccount` field. You can locate the unique DICOM account name in that workspace in the `data.serviceHostName` field. When you create a subscription, you can use the filtering operators to select the events you want to get in that subscription.
72+
Use the Event Grid filtering feature. There are unique identifiers in the event message payload to differentiate accounts and workspaces. You can find a global unique identifier for workspace in the `source` field, which is the Azure Resource ID. You can locate the unique FHIR account name in that workspace in the `data.resourceFhirAccount` field. You can locate the unique DICOM account name in the workspace in the `data.serviceHostName` field. When you create a subscription, use the filtering operators to select the events you want to include in the subscription.
7473

7574
:::image type="content" source="media\event-grid\event-grid-filters.png" alt-text="Screenshot of the Event Grid filters tab." lightbox="media\event-grid\event-grid-filters.png":::
7675

77-
## Can I use the same subscriber for multiple workspaces, FHIR accounts, or DICOM accounts?
76+
**Can I use the same subscriber for multiple workspaces, FHIR accounts, or DICOM accounts?**
7877

79-
Yes. We recommend that you use different subscribers for each individual FHIR or DICOM service to process in isolated scopes.
78+
Yes. We recommend that you use different subscribers for each FHIR or DICOM service to enable processing in isolated scopes.
8079

81-
## Is Event Grid compatible with HIPAA and HITRUST compliance obligations?
80+
**Is the Event Grid compatible with HIPAA and HITRUST compliance requirements?**
8281

83-
Yes. Event Grid supports customer's Health Insurance Portability and Accountability Act (HIPAA) and Health Information Trust Alliance (HITRUST) obligations. For more information, see [Microsoft Azure Compliance Offerings](https://azure.microsoft.com/resources/microsoft-azure-compliance-offerings/).
82+
Yes. Event Grid supports Health Insurance Portability and Accountability Act (HIPAA) and Health Information Trust Alliance (HITRUST) obligations. For more information, see [Microsoft Azure Compliance Offerings](https://azure.microsoft.com/resources/microsoft-azure-compliance-offerings/).
8483

85-
## What is the expected time to receive an events message?
84+
**How long does it take to receive an events message?**
8685

87-
On average, you should receive your event message within one second after a successful HTTP request. 99.99% of the event messages should be delivered within five seconds unless the limitation of either the FHIR service, DICOM service, or [Event Grid](../../event-grid/quotas-limits.md) has been met.
86+
On average, you should receive your event message within one second after a successful HTTP request. 99.99% of the event messages should be delivered within five seconds unless the limitation of either the FHIR service, DICOM service, or [Event Grid](../../event-grid/quotas-limits.md) is reached.
8887

89-
## Is it possible to receive duplicate events messages?
88+
**Is it possible to receive duplicate events messages?**
9089

91-
Yes. The Event Grid guarantees at least one events message delivery with its push mode. There may be chances that the event delivery request returns with a transient failure status code for random reasons. In this situation, the Event Grid considers that as a delivery failure and resends the events message. For more information, see [Azure Event Grid delivery and retry](../../event-grid/delivery-and-retry.md).
90+
Yes. The Event Grid guarantees at least one events message delivery with its push mode. There may be cases when the event delivery request returns with a transient failure status code for random reasons. In this situation, the Event Grid considers it a delivery failure and resends the events message. For more information, see [Azure Event Grid delivery and retry](../../event-grid/delivery-and-retry.md).
9291

93-
Generally, we recommend that developers ensure idempotency for the event subscriber. The event ID or the combination of all fields in the `data` property of the message content are unique per each event. The developer can rely on them to deduplicate.
92+
Generally, we recommend that developers ensure idempotency for the event subscriber. The event ID or the combination of all fields in the `data` property of the message content are unique for each event. You can rely on them to deduplicate.
9493

95-
## More frequently asked questions
96-
97-
[FAQs about the Azure Health Data Services](../healthcare-apis-faqs.md)
98-
99-
[FAQs about Azure Health Data Services DICOM service](../dicom/dicom-services-faqs.yml)
100-
101-
[FAQs about Azure Health Data Services FHIR service](../fhir/fhir-faq.md)
102-
103-
[FAQs about Azure Health Data Services MedTech service](../iot/iot-connector-faqs.md)
104-
105-
FHIR® is a registered trademark of Health Level Seven International, registered in the U.S. Trademark Office and is used with their permission.
94+
[!INCLUDE [FHIR and DICOM trademark statement](../includes/healthcare-apis-fhir-dicom-trademark.md)]
554 KB
Loading
400 KB
Loading
737 KB
Loading
625 KB
Loading
400 KB
Loading

0 commit comments

Comments
 (0)