Skip to content

Commit b87e52b

Browse files
committed
Content updates as needed
1 parent 007964e commit b87e52b

File tree

3 files changed

+30
-35
lines changed

3 files changed

+30
-35
lines changed

articles/healthcare-apis/events/events-enable-diagnostic-settings.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,12 @@ author: chachachachami
66
ms.service: azure-health-data-services
77
ms.subservice: fhir
88
ms.topic: how-to
9-
ms.date: 06/23/2022
9+
ms.date: 11/26/2024
1010
ms.author: chrupa
1111
---
1212

1313
# How to enable diagnostic settings for events
1414

15-
> [!NOTE]
16-
> [Fast Healthcare Interoperability Resources (FHIR®)](https://www.hl7.org/fhir/) is an open healthcare specification.
17-
1815
In this article, learn how to enable the events diagnostic settings for Azure Event Grid system topics.
1916

2017
## Resources
@@ -37,5 +34,3 @@ To learn how to use events metrics using the Azure portal, see
3734

3835
> [!div class="nextstepaction"]
3936
> [How to use events metrics](events-use-metrics.md)
40-
41-
FHIR® is a registered trademark of Health Level Seven International, registered in the U.S. Trademark Office and is used with their permission.

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

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,21 @@ author: chachachachami
66
ms.service: azure-health-data-services
77
ms.subservice: events
88
ms.topic: reference
9-
ms.date: 01/31/2024
9+
ms.date: 11/26/2024
1010
ms.author: chrupa
1111
---
1212

1313
# Events FAQ
1414

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.
1616

1717
**Can I use events with a non-Microsoft FHIR or DICOM service?**
1818

1919
No. The Events capability only supports the Azure Health Data Services FHIR and DICOM services.
2020

2121
**What FHIR resource changes are supported by events?**
2222

23-
Events are generated from these FHIR service types:
23+
Events are generated from the following FHIR service types.
2424

2525
- **FhirResourceCreated**. The event emitted after a FHIR resource is created.
2626

@@ -34,11 +34,11 @@ For more information about delete types in the FHIR service, see [REST API capab
3434

3535
Yes. The events capability emits notifications of data changes at the FHIR resource level.
3636

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).
3838

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.
4040

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.
4242

4343
> [!NOTE]
4444
> 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:
5555

5656
**What is the payload of an events message?**
5757

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).
5959

6060
**What is the throughput for events messages?**
6161

@@ -67,7 +67,7 @@ There are no extra charges for using [Azure Health Data Services events](https:/
6767

6868
**How do I subscribe separately to multiple FHIR or DICOM services in the same workspace?**
6969

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.
7171

7272
:::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":::
7373

@@ -81,12 +81,12 @@ Yes. Event Grid supports Health Insurance Portability and Accountability Act (HI
8181

8282
**How long does it take to receive an events message?**
8383

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.
8585

8686
**Is it possible to receive duplicate events messages?**
8787

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.
8991

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-
9292
[!INCLUDE [FHIR and DICOM trademark statement](../includes/healthcare-apis-fhir-dicom-trademark.md)]

articles/healthcare-apis/events/events-message-structure.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ author: chachachachami
66
ms.service: azure-health-data-services
77
ms.subservice: fhir
88
ms.topic: reference
9-
ms.date: 07/11/2023
9+
ms.date: 11/26/2024
1010
ms.author: chrupa
1111
---
1212

@@ -17,13 +17,13 @@ In this article, learn about the events message structures, required and nonrequ
1717
> [!IMPORTANT]
1818
> Events currently supports these operations:
1919
>
20-
> * **FhirResourceCreated** - The event emitted after a FHIR resource gets created successfully.
20+
> * **FhirResourceCreated** - The event emitted after a FHIR&reg; resource gets created successfully.
2121
>
2222
> * **FhirResourceUpdated** - The event emitted after a FHIR resource gets updated successfully.
2323
>
2424
> * **FhirResourceDeleted** - The event emitted after a FHIR resource gets soft deleted successfully.
2525
>
26-
> * **DicomImageCreated** - The event emitted after a DICOM image gets created successfully.
26+
> * **DicomImageCreated** - The event emitted after a DICOM&reg; image gets created successfully.
2727
>
2828
> * **DicomImageDeleted** - The event emitted after a DICOM image gets deleted successfully.
2929
>
@@ -181,19 +181,19 @@ In this article, learn about the events message structures, required and nonrequ
181181
|Name | Type | Required | Description |
182182
|-----|------|----------|-------------|
183183
|`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.
188-
| `data` | object | Yes | DICOM image change event details.
189-
| `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.
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. |
188+
| `data` | object | Yes | DICOM image change event details. |
189+
| `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. |
197197

198198
## DICOM events message samples
199199

@@ -339,4 +339,4 @@ To learn how to deploy events using the Azure portal, see
339339
> [!div class="nextstepaction"]
340340
> [Deploy events using the Azure portal](events-deploy-portal.md)
341341
342-
FHIR&#174; 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

Comments
 (0)