You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/healthcare-apis/events/events-faqs.md
+12-12Lines changed: 12 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,21 +6,21 @@ author: chachachachami
6
6
ms.service: azure-health-data-services
7
7
ms.subservice: events
8
8
ms.topic: reference
9
-
ms.date: 01/31/2024
9
+
ms.date: 11/26/2024
10
10
ms.author: chrupa
11
11
---
12
12
13
13
# Events FAQ
14
14
15
-
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.
15
+
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 find answers to some common questions about events.
16
16
17
17
**Can I use events with a non-Microsoft FHIR or DICOM service?**
18
18
19
19
No. The Events capability only supports the Azure Health Data Services FHIR and DICOM services.
20
20
21
21
**What FHIR resource changes are supported by events?**
22
22
23
-
Events are generated from these FHIR service types:
23
+
Events are generated from the following FHIR service types.
24
24
25
25
-**FhirResourceCreated**. The event emitted after a FHIR resource is created.
26
26
@@ -34,11 +34,11 @@ For more information about delete types in the FHIR service, see [REST API capab
34
34
35
35
Yes. The events capability emits notifications of data changes at the FHIR resource level.
36
36
37
-
Events support these [FHIR bundle types](http://hl7.org/fhir/R4/valueset-bundle-type.html):
37
+
Events support the following [FHIR bundle types](http://hl7.org/fhir/R4/valueset-bundle-type.html).
38
38
39
-
-**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.
39
+
-**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. <br>For example: a batch bundle contains five operations, one of which has an error. Events are emitted for the four successful operations with no event emitted for the operation that generated an error.
40
40
41
-
-**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.
41
+
-**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. <br>For example: a batch bundle contains five operations, one of which has an error. No events are emitted for that bundle.
42
42
43
43
> [!NOTE]
44
44
> Events aren't sent in the sequence of the data operations in the FHIR bundle.
@@ -55,7 +55,7 @@ Events are generated from the following DICOM service types:
55
55
56
56
**What is the payload of an events message?**
57
57
58
-
For a description of the events message structure and required and nonrequired elements, see [Events message structures](events-message-structure.md).
58
+
For a description of the events message structure, including required and nonrequired elements, see [Events message structures](events-message-structure.md).
59
59
60
60
**What is the throughput for events messages?**
61
61
@@ -67,7 +67,7 @@ There are no extra charges for using [Azure Health Data Services events](https:/
67
67
68
68
**How do I subscribe separately to multiple FHIR or DICOM services in the same workspace?**
69
69
70
-
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.
70
+
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 a 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.
71
71
72
72
:::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
73
@@ -81,12 +81,12 @@ Yes. Event Grid supports Health Insurance Portability and Accountability Act (HI
81
81
82
82
**How long does it take to receive an events message?**
83
83
84
-
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.
84
+
On average, you should receive your events message within one second after a successful HTTP request. 99.99% of the event messages should be delivered within five seconds unless limitation of the FHIR service, DICOM service, or [Event Grid](../../event-grid/quotas-limits.md) is reached.
85
85
86
86
**Is it possible to receive duplicate events messages?**
87
87
88
-
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).
88
+
Yes. The Event Grid guarantees at least one event message delivery with its push mode. There may be cases when the event delivery request returns with a transient failure status code. 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).
89
+
90
+
Generally, we recommend 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.
89
91
90
-
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.
91
-
92
92
[!INCLUDE [FHIR and DICOM trademark statement](../includes/healthcare-apis-fhir-dicom-trademark.md)]
Copy file name to clipboardExpand all lines: articles/healthcare-apis/events/events-message-structure.md
+17-17Lines changed: 17 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ author: chachachachami
6
6
ms.service: azure-health-data-services
7
7
ms.subservice: fhir
8
8
ms.topic: reference
9
-
ms.date: 07/11/2023
9
+
ms.date: 11/26/2024
10
10
ms.author: chrupa
11
11
---
12
12
@@ -17,13 +17,13 @@ In this article, learn about the events message structures, required and nonrequ
17
17
> [!IMPORTANT]
18
18
> Events currently supports these operations:
19
19
>
20
-
> ***FhirResourceCreated** - The event emitted after a FHIR resource gets created successfully.
20
+
> ***FhirResourceCreated** - The event emitted after a FHIR® resource gets created successfully.
21
21
>
22
22
> ***FhirResourceUpdated** - The event emitted after a FHIR resource gets updated successfully.
23
23
>
24
24
> ***FhirResourceDeleted** - The event emitted after a FHIR resource gets soft deleted successfully.
25
25
>
26
-
> ***DicomImageCreated** - The event emitted after a DICOM image gets created successfully.
26
+
> ***DicomImageCreated** - The event emitted after a DICOM® image gets created successfully.
27
27
>
28
28
> ***DicomImageDeleted** - The event emitted after a DICOM image gets deleted successfully.
29
29
>
@@ -181,19 +181,19 @@ In this article, learn about the events message structures, required and nonrequ
181
181
|Name | Type | Required | Description |
182
182
|-----|------|----------|-------------|
183
183
|`topic` | string | Yes | The topic is the Azure Resource ID of your Azure Health Data Services workspace.
184
-
|`subject` | string | Yes | The Uniform Resource Identifier (URI) of the DICOM image that was changed. Customer can access the image with the subject with https:// scheme. Customer should use the dataVersion or data.resourceVersionId to visit specific data version regarding this event.
185
-
| `eventType` | string(enum) | Yes | The type of change on the DICOM image.
186
-
| `eventTime` | string(datetime) | Yes | The UTC time when the DICOM image change was committed.
187
-
| `id` | string | Yes | Unique identifier for the event.
| `data.serviceHostName` | string | Yes | The hostname of the DICOM service where the change occurred.
194
-
| `data.sequenceNumber` | int | Yes | The sequence number of the change in the DICOM service. Every image creation and deletion have a unique sequence within the service. This number correlates to the sequence number of the DICOM service's Change Feed. Querying the DICOM Service Change Feed with this sequence number gives you the change that created this event.
195
-
| `dataVersion` | string | No | The data version of the DICOM image.
196
-
| `metadataVersion` | string | No | The schema version of the event metadata. This is defined by Azure Event Grid and should be constant most of the time.
184
+
|`subject`| string | Yes | The Uniform Resource Identifier (URI) of the DICOM image that was changed. Customer can access the image with the subject with https:// scheme. Customer should use the dataVersion or data.resourceVersionId to visit specific data version regarding this event.|
185
+
|`eventType`| string(enum) | Yes | The type of change on the DICOM image.|
186
+
|`eventTime`| string(datetime) | Yes | The UTC time when the DICOM image change was committed.|
187
+
|`id`| string | Yes | Unique identifier for the event.|
|`data.partitionName`| string | No | Data partition name.|
190
+
|`data.imageStudyInstanceUid`| string | Yes | The image's Study Instance UID.|
191
+
|`data.imageSeriesInstanceUid`| string | Yes | The image's Series Instance UID.|
192
+
|`data.imageSopInstanceUid`| string | Yes | The image's SOP Instance UID.|
193
+
|`data.serviceHostName`| string | Yes | The hostname of the DICOM service where the change occurred. |
194
+
|`data.sequenceNumber`| int | Yes | The sequence number of the change in the DICOM service. Every image creation and deletion have a unique sequence within the service. This number correlates to the sequence number of the DICOM service's Change Feed. Querying the DICOM Service Change Feed with this sequence number gives you the change that created this event.|
195
+
|`dataVersion`| string | No | The data version of the DICOM image.|
196
+
|`metadataVersion`| string | No | The schema version of the event metadata. This is defined by Azure Event Grid and should be constant most of the time.|
197
197
198
198
## DICOM events message samples
199
199
@@ -339,4 +339,4 @@ To learn how to deploy events using the Azure portal, see
339
339
> [!div class="nextstepaction"]
340
340
> [Deploy events using the Azure portal](events-deploy-portal.md)
341
341
342
-
FHIR® is a registered trademark of Health Level Seven International, registered in the U.S. Trademark Office and is used with their permission.
342
+
[!INCLUDE [FHIR and DICOM trademark statement](../includes/healthcare-apis-fhir-dicom-trademark.md)]
0 commit comments