|
1 | 1 | --- |
2 | | -title: What are events? - Azure Health Data Services |
3 | | -description: Learn about events, its features, integrations, and next steps. |
| 2 | +title: What are events in Azure Health Data Services? |
| 3 | +description: Learn how to use events in Azure Health Data Services to subscribe to and receive notifications of changes to health data in the FHIR and DICOM services, and trigger other actions or services based on health data changes. |
4 | 4 | services: healthcare-apis |
5 | 5 | author: msjasteppe |
6 | 6 | ms.service: healthcare-apis |
7 | | -ms.subservice: fhir |
| 7 | +ms.subservice: events |
8 | 8 | ms.topic: overview |
9 | | -ms.date: 09/01/2023 |
| 9 | +ms.date: 01/29/2024 |
10 | 10 | ms.author: jasteppe |
11 | 11 | --- |
12 | 12 |
|
13 | 13 | # What are events? |
14 | 14 |
|
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)] |
17 | 16 |
|
18 | | -Events are a subscription and notification feature in the Azure Health Data Services. Events enable customers to utilize and enhance the analysis and workflows of structured and unstructured data like vitals and clinical or progress notes, operations data, health data, and medical imaging data. |
| 17 | +Events in Azure Health Data Services allow you to subscribe to and receive notifications of changes to health data in the FHIR® service or the DICOM® service. Events also enable you to trigger other actions or services based changes to health data, such as starting workflows, sending email, text messages, or alerts. |
19 | 18 |
|
20 | | -When FHIR resource changes or Digital Imaging and Communications in Medicine (DICOM) image changes are successfully written to the Azure Health Data Services, the events feature sends notification messages to events subscribers. These event notification occurrences can be sent to multiple endpoints to trigger automation ranging from starting workflows to sending email and text messages to support the changes occurring from the health data it originated from. The events feature integrates with the [Azure Event Grid service](../../event-grid/overview.md) and creates a system topic for the Azure Health Data Services workspace. |
| 19 | +Events are: |
21 | 20 |
|
22 | | -> [!IMPORTANT] |
23 | | -> FHIR resource and DICOM image change data is only written and event messages are sent when the events feature is turned on. The event feature doesn't send messages on past resource changes or when the feature is turned off. |
| 21 | +- **Scalable**. Events support growth and change in an organization's healthcare data needs by using the [Azure Event Grid service](../../event-grid/overview.md) and creating a [system topic](../../event-grid/system-topics.md) for Azure Health Data Services. For more information, see [Azure Event Grid event schema](../../event-grid/event-schema.md) and [Azure Health Data Services as an Event Grid source](../../event-grid/event-schema-azure-health-data-services.md). |
24 | 22 |
|
25 | | -> [!TIP] |
26 | | -> For more information about the features, configurations, and to learn about the use cases of the Azure Event Grid service, see [Azure Event Grid](../../event-grid/overview.md) |
| 23 | +- **Configurable**. Choose which FHIR and DICOM event types trigger event notifications. Use advanced features built into the Azure Event Grid service, such as filters, dead-lettering, and retry policies to tune message delivery options for events. |
27 | 24 |
|
28 | | -:::image type="content" source="media/events-overview/events-overview-flow.png" alt-text="Diagram of data flow from users to a FHIR service and then into the events pipeline." lightbox="media/events-overview/events-overview-flow.png"::: |
29 | | - |
30 | | -> [!IMPORTANT] |
31 | | -> Events currently supports the following operations: |
32 | | -> |
33 | | -> * **FhirResourceCreated** - The event emitted after a FHIR resource gets created successfully. |
34 | | -> |
35 | | -> * **FhirResourceUpdated** - The event emitted after a FHIR resource gets updated successfully. |
36 | | -> |
37 | | -> * **FhirResourceDeleted** - The event emitted after a FHIR resource gets soft deleted successfully. |
38 | | -> |
39 | | -> * **DicomImageCreated** - The event emitted after a DICOM image gets created successfully. |
40 | | -> |
41 | | -> * **DicomImageDeleted** - The event emitted after a DICOM image gets deleted successfully. |
42 | | -> |
43 | | -> - **DicomImageUpdated** - The event emitted after a DICOM image gets updated successfully. |
44 | | -> |
45 | | -> 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). |
46 | | -
|
47 | | -## Scalable |
48 | | - |
49 | | -Events are designed to support growth and changes in healthcare technology needs by using the [Azure Event Grid service](../../event-grid/overview.md) and creating a system topic for the Azure Health Data Services Workspace. |
50 | | - |
51 | | -## Configurable |
| 25 | +- **Extensible**. Use events to send FHIR resource and DICOM image change messages to [Azure Event Hubs](../../event-hubs/event-hubs-about.md) or [Azure Functions](../../azure-functions/functions-overview.md). to trigger downstream automated workflows that enhance operational data, data analysis, and visibility of the incoming data capturing in near real time. |
| 26 | + |
| 27 | +- **Secure**. Events are built on a platform that supports protected health information (PHI) compliance with privacy, safety, and security standards. Use [Azure managed identities](../../active-directory/managed-identities-azure-resources/overview.md) to provide secure access from the Event Grid system topic to the events message-receiving endpoints of your choice. |
52 | 28 |
|
53 | | -Choose the FHIR and DICOM event types that you want to receive messages about. Use the advanced features like filters, dead-lettering, and retry policies to tune events message delivery options. |
| 29 | +:::image type="content" source="media/events-overview/events-overview-flow.png" alt-text="Diagram of data flow from users to a FHIR service and then into the events pipeline." lightbox="media/events-overview/events-overview-flow.png"::: |
54 | 30 |
|
55 | | -> [!NOTE] |
56 | | -> The advanced features come as part of the Event Grid service. |
| 31 | +## Supported operations |
57 | 32 |
|
58 | | -## Extensible |
| 33 | +Events support these operations: |
59 | 34 |
|
60 | | -Use events to send FHIR resource and DICOM image change messages to services like [Azure Event Hubs](../../event-hubs/event-hubs-about.md) or [Azure Functions](../../azure-functions/functions-overview.md) to trigger downstream automated workflows to enhance items such as operational data, data analysis, and visibility to the incoming data capturing near real time. |
61 | | - |
62 | | -## Secure |
| 35 | +| Operation | Trigger condition | |
| 36 | +|---------------------|----------------------------------| |
| 37 | +| FhirResourceCreated | A FHIR resource was created. | |
| 38 | +| FhirResourceUpdated | A FHIR resource was updated. | |
| 39 | +| FhirResourceDeleted | A FHIR resource was soft deleted. | |
| 40 | +| DicomImageCreated | A DICOM image was created. | |
| 41 | +| DicomImageDeleted | A DICOM image was deleted. | |
| 42 | +| DicomImageUpdated | A DICOM image was updated. | |
63 | 43 |
|
64 | | -Events are built on a platform that supports protected health information compliance with privacy, safety, and security in mind. |
| 44 | +For more information about delete types in the FHIR service, see [FHIR REST API capabilities in Azure Health Data Services](../../healthcare-apis/fhir/fhir-rest-api-capabilities.md). |
65 | 45 |
|
66 | | -Use [Azure Managed identities](../../active-directory/managed-identities-azure-resources/overview.md) to provide secure access from your Event Grid system topic to the events message receiving endpoints of your choice. |
| 46 | +> [!IMPORTANT] |
| 47 | +> Event notifications are sent only when the capability is turned on. The events capability doesn't send messages for past changes or when the capability is turned off. |
67 | 48 |
|
68 | 49 | ## Next steps |
69 | 50 |
|
70 | | -To learn about deploying events using the Azure portal, see |
71 | | - |
72 | | -> [!div class="nextstepaction"] |
73 | | -> [Deploy events using the Azure portal](events-deploy-portal.md) |
| 51 | +[Deploy events using the Azure portal](events-deploy-portal.md) |
74 | 52 |
|
75 | | -To learn about troubleshooting events, see |
| 53 | +[Troubleshoot events](events-troubleshooting-guide.md) |
76 | 54 |
|
77 | | -> [!div class="nextstepaction"] |
78 | | -> [Troubleshoot events](events-troubleshooting-guide.md) |
79 | | -
|
80 | | -To learn about the frequently asks questions (FAQs) about events, see |
81 | | - |
82 | | -> [!div class="nextstepaction"] |
83 | | -> [Frequently asked questions about Events](events-faqs.md) |
| 55 | +[Events FAQ](events-faqs.md) |
84 | 56 |
|
85 | | -FHIR® is a registered trademark of Health Level Seven International, registered in the U.S. Trademark Office and is used with their permission. |
| 57 | +[!INCLUDE [FHIR DICOM trademark statement](../includes/healthcare-apis-fhir-dicom-trademark.md)] |
0 commit comments