Skip to content

Commit 0f22d56

Browse files
authored
Merge pull request #232517 from msjasteppe/events-faqs-updates
Adding FHIR bundle support section
2 parents 3437fdc + 4a2ce08 commit 0f22d56

File tree

1 file changed

+32
-16
lines changed

1 file changed

+32
-16
lines changed

articles/healthcare-apis/events/events-faqs.md

Lines changed: 32 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,25 @@
11
---
2-
title: FAQs about Events in Azure Health Data Services
3-
description: This document provides answers to the frequently asked questions about Events.
2+
title: Frequently asked questions about Events - Azure Health Data Services
3+
description: This article provides answers to the frequently asked questions about Events.
44
services: healthcare-apis
55
author: msjasteppe
66
ms.service: healthcare-apis
77
ms.subservice: fhir
88
ms.topic: reference
9-
ms.date: 07/06/2022
9+
ms.date: 04/04/2022
1010
ms.author: jasteppe
1111
---
1212

13-
# Frequently asked questions (FAQs) about Events
13+
# Frequently asked questions about Events
1414

15-
The following are some of the frequently asked questions about Events.
15+
> [!NOTE]
16+
> [Fast Healthcare Interoperability Resources (FHIR®)](https://www.hl7.org/fhir/) is an open healthcare specification.
1617
1718
## Events: The basics
1819

1920
### Can I use Events with a different FHIR/DICOM service other than the Azure Health Data Services FHIR/DICOM service?
2021

21-
No. The Azure Health Data Services Events feature only currently supports the Azure Health Data Services Fast Healthcare Interoperability Resources (FHIR®) and DICOM services.
22+
No. The Azure Health Data Services Events feature only currently supports the Azure Health Data Services FHIR and DICOM services.
2223

2324
### What FHIR resource events does Events support?
2425

@@ -30,9 +31,23 @@ Events are generated from the following FHIR service types:
3031

3132
- **FhirResourceDeleted** - The event emitted after a FHIR resource gets soft deleted successfully.
3233

33-
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)
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).
35+
36+
### Does Events support FHIR bundles?
37+
38+
Yes. The Events feature is designed to emit notifications of data changes at the FHIR resource level.
39+
40+
Events support these [FHIR bundle types](http://hl7.org/fhir/R4/valueset-bundle-type.html) in the following ways:
41+
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.
43+
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.
45+
46+
> [!NOTE]
47+
> Events are not sent in the sequence of the data operations in the FHIR bundle.
3448
3549
### What DICOM image events does Events support?
50+
3651
Events are generated from the following DICOM service types:
3752

3853
- **DicomImageCreated** - The event emitted after a DICOM image gets created successfully.
@@ -41,21 +56,21 @@ Events are generated from the following DICOM service types:
4156

4257
### What is the payload of an Events message?
4358

44-
For a detailed description of the Events message structure and both required and non-required elements, see [Events troubleshooting guide](events-troubleshooting-guide.md).
59+
For a detailed description of the Events message structure and both required and nonrequired elements, see [Events troubleshooting guide](events-troubleshooting-guide.md).
4560

4661
### What is the throughput for the Events messages?
4762

48-
The throughput of FHIR and DICOM events is governed by the throughput of the FHIR or DICOM service and the Event Grid. When a request made to the FHIR service is successful, it will return a 2xx HTTP status code. It will also generate a FHIR resource or DICOM image changing event. The current limitation is 5,000 events/second per a workspace for all FHIR or DICOM service instances in it.
63+
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 a workspace for all FHIR or DICOM service instances in it.
4964

5065
### How am I charged for using Events?
5166

52-
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/) will be assessed against your Azure subscription.
67+
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.
5368

5469
### How do I subscribe to multiple FHIR and/or DICOM services in the same workspace separately?
5570

5671
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.
5772

58-
:::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":::
73+
:::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":::
5974

6075
### Can I use the same subscriber for multiple workspaces, FHIR accounts, or DICOM accounts?
6176

@@ -65,17 +80,18 @@ Yes. We recommend that you use different subscribers for each individual FHIR or
6580

6681
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/).
6782

68-
### What is the expected time to receive an Events message?
83+
### What is the expected time to receive an Events message?
6984

7085
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.
7186

72-
### Is it possible to receive duplicate Events message?
87+
### Is it possible to receive duplicate Events messages?
7388

74-
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 will consider that as a delivery failure and will resend the Events message. For more information, see [Azure Event Grid delivery and retry](../../event-grid/delivery-and-retry.md).
89+
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).
7590

76-
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 de-duplicate.
91+
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.
7792

78-
## More frequently asked questions
93+
### More frequently asked questions
94+
7995
[FAQs about the Azure Health Data Services](../healthcare-apis-faqs.md)
8096

8197
[FAQs about Azure Health Data Services FHIR service](../fhir/fhir-faq.md)

0 commit comments

Comments
 (0)