Skip to content

Commit 6ceed2c

Browse files
Merge pull request #242795 from msjasteppe/events-faqs-updates
Working on incrementally increasing Acrolinx score
2 parents 640ca64 + f6b958e commit 6ceed2c

10 files changed

+123
-99
lines changed

articles/healthcare-apis/events/events-consume-logic-apps.md

Lines changed: 36 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,21 @@
11
---
22
title: Consume events with Logic Apps - Azure Health Data Services
3-
description: This tutorial provides resources on how to consume events with Logic Apps.
3+
description: Learn how to consume FHIR events with Logic Apps.
44
services: healthcare-apis
55
author: msjasteppe
66
ms.service: healthcare-apis
77
ms.subservice: fhir
88
ms.topic: tutorial
9-
ms.date: 12/21/2022
9+
ms.date: 06/23/2022
1010
ms.author: jasteppe
1111
---
1212

13-
# Tutorial: Consume events with Logic Apps
13+
# Tutorial: Consume FHIR events with Logic Apps
1414

15-
This tutorial shows how to use Azure Logic Apps to process Azure Health Data Services Fast Healthcare Interoperability Resources (FHIR®) events. Logic Apps creates and runs automated workflows to process event data from other applications. You'll learn how to register a FHIR event with your Logic App, meet a specified event criteria, and perform a service operation.
15+
> [!NOTE]
16+
> [Fast Healthcare Interoperability Resources (FHIR®)](https://www.hl7.org/fhir/) is an open healthcare specification.
17+
18+
This tutorial shows how to use Azure Logic Apps to process Azure Health Data Services FHIR events. Logic Apps creates and runs automated workflows to process event data from other applications. Learn how to register a FHIR event with your Logic App, meet a specified event criteria, and perform a service operation.
1619

1720
Here's an example of a Logic App workflow:
1821

@@ -41,13 +44,13 @@ To set up an automated workflow, you must first create a Logic App. For more inf
4144
Follow these steps:
4245

4346
1. Go to the Azure portal.
44-
2. Search for "Logic App".
45-
3. Select "Add".
46-
4. Specify Basic details.
47-
5. Specify Hosting.
48-
6. Specify Monitoring.
49-
7. Specify Tags.
50-
8. Review and create your Logic App.
47+
2. Search for **Logic App**.
48+
3. Select **Add**.
49+
4. Specify **Basic details**.
50+
5. Specify **Hosting**.
51+
6. Specify **Monitoring**.
52+
7. Specify **Tags**.
53+
8. **Review and create** your Logic App.
5154

5255
You now need to fill out the details of your Logic App. Specify information for these five categories. They are in separate tabs:
5356

@@ -90,7 +93,7 @@ Choose a plan type (Standard or Consumption). Create a new Windows Plan name and
9093

9194
- Zone redundancy deployment
9295

93-
Enabling your plan will make it zone redundant.
96+
Enabling your plan makes it zone redundant.
9497

9598
### Hosting - Tab 2
9699

@@ -117,21 +120,21 @@ Enable Azure Monitor Application Insights to automatically monitor your applicat
117120

118121
### Tags - Tab 4
119122

120-
Continue specifying your Logic App by clicking "Next: Tags".
123+
Continue specifying your Logic App by clicking **Next: Tags**.
121124

122125
#### Use tags to categorize resources
123126

124127
Tags are name/value pairs that enable you to categorize resources and view consolidated billing by applying the same tag to multiple resources and resource groups.
125128

126-
This example won't use tagging.
129+
This example doesn't use tagging.
127130

128131
### Review + create - Tab 5
129132

130-
Finish specifying your Logic App by clicking "Next: Review + create".
133+
Finish specifying your Logic App by clicking **Next: Review + create**.
131134

132135
#### Review your Logic App
133136

134-
Your proposed Logic app will display the following details:
137+
Your proposed Logic app displays the following details:
135138

136139
- Subscription
137140
- Resource Group
@@ -142,7 +145,7 @@ Your proposed Logic app will display the following details:
142145
- Plan
143146
- Monitoring
144147

145-
If you're satisfied with the proposed configuration, select "Create". If not, select "Previous" to go back and specify new details.
148+
If you're satisfied with the proposed configuration, select **Create**. If not, select **Previous** to go back and specify new details.
146149

147150
First you'll see an alert telling you that deployment is initializing. Next you'll see a new page telling you that the deployment is in progress.
148151

@@ -154,7 +157,7 @@ If there are no errors, you'll finally see a notification telling you that your
154157

155158
#### Your Logic App dashboard
156159

157-
Azure creates a dashboard when your Logic App is complete. The dashboard will show you the status of your app. You can return to your dashboard by clicking Overview in the Logic App menu. Here's a Logic App dashboard:
160+
Azure creates a dashboard when your Logic App is complete. The dashboard shows you the status of your app. You can return to your dashboard by clicking Overview in the Logic App menu. Here's a Logic App dashboard:
158161

159162
:::image type="content" source="media/events-logic-apps/events-logic-overview.png" alt-text="Screenshot of your Logic Apps overview dashboard." lightbox="media/events-logic-apps/events-logic-overview.png":::
160163

@@ -189,10 +192,10 @@ Before you begin, you'll need to have a Logic App configured and running correct
189192
Once your Logic App is running, you can create and configure a workflow. To initialize a workflow, follow these steps:
190193

191194
1. Start at the Azure portal.
192-
2. Select "Logic Apps" in Azure services.
195+
2. Select **Logic Apps** in Azure services.
193196
3. Select the Logic App you created.
194-
4. Select "Workflows" in the Workflow menu on the left.
195-
5. Select "Add" to add a workflow.
197+
4. Select **Workflows** in the Workflow menu on the left.
198+
5. Select **Add** to add a workflow.
196199

197200
### Configuring a new workflow
198201

@@ -244,7 +247,7 @@ Fill in the details for subscription, resource type, and resource name. Then you
244247
- Resource deleted
245248
- Resource updated
246249

247-
For more information about event types, see [What FHIR resource events does Events support?](events-faqs.md).
250+
For more information about event types, see [What FHIR resource events does Events support?](events-faqs.md#what-fhir-resource-events-does-events-support).
248251

249252
### Adding an HTTP action
250253

@@ -285,9 +288,9 @@ When the condition is ready, you can specify what actions happen if the conditio
285288

286289
### Choosing a condition criteria
287290

288-
In order to specify whether you want to take action for the specific event, begin specifying the criteria by clicking on "Condition" in the workflow on the left. You'll then see a set of condition choices on the right.
291+
In order to specify whether you want to take action for the specific event, begin specifying the criteria by clicking on **Condition** in the workflow. A set of condition choices are then displayed.
289292

290-
Under the "And" box, add these two conditions:
293+
Under the **And** box, add these two conditions:
291294

292295
- resourceType
293296
- Event Type
@@ -331,19 +334,24 @@ To test your new workflow, do the following steps:
331334
1. Add a new Patient FHIR Resource to your FHIR Service.
332335
2. Wait a moment or two and then check the Overview webpage of your Logic App workflow.
333336
3. The event should be shaded in green if the action was successful.
334-
4. If it failed, the event will be shaded in red.
337+
4. If it failed, the event is shaded in red.
335338

336339
Here's an example of a workflow trigger success operation:
337340

338341
:::image type="content" source="media/events-logic-apps/events-logic-success.png" alt-text="Screenshot showing workflow success indicated by green highlighting of the workflow name." lightbox="./media/events-logic-apps/events-logic-success.png":::
339342

340343
## Next steps
341344

342-
In this tutorial, you learned about how to use Logic Apps to process FHIR events.
345+
In this tutorial, you learned how to use Logic Apps to process FHIR events.
346+
347+
To learn about Events, see
348+
349+
> [!div class="nextstepaction"]
350+
> [What are Events?](events-overview.md)
343351
344-
To learn more about FHIR events, see:
352+
To learn about the Events frequently asked questions (FAQs), see
345353

346354
> [!div class="nextstepaction"]
347-
> [What are Events?](./events-overview.md)
355+
> [Frequently asked questions about Events](events-faqs.md)
348356
349357
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-deploy-portal.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,21 @@
11
---
22
title: Deploy Events using the Azure portal - Azure Health Data Services
3-
description: This article describes how to deploy the Events feature in the Azure portal.
3+
description: Learn how to deploy the Events feature using the Azure portal.
44
services: healthcare-apis
55
author: msjasteppe
66
ms.service: healthcare-apis
77
ms.subservice: fhir
88
ms.topic: quickstart
9-
ms.date: 10/21/2022
9+
ms.date: 06/23/2022
1010
ms.author: jasteppe
1111
---
1212

1313
# Quickstart: Deploy Events using the Azure portal
1414

15-
In this quickstart, you’ll learn how to deploy the Azure Health Data Services Events feature in the Azure portal to send Fast Healthcare Interoperability Resources (FHIR®) and DICOM event messages.
15+
> [!NOTE]
16+
> [Fast Healthcare Interoperability Resources (FHIR®)](https://www.hl7.org/fhir/) is an open healthcare specification.
17+
18+
In this quickstart, learn how to deploy the Azure Health Data Services Events feature in the Azure portal to send FHIR and DICOM event messages.
1619

1720
## Prerequisites
1821

@@ -57,7 +60,7 @@ It's important that you have the following prerequisites completed before you be
5760

5861
4. After the form is completed, select **Create** to begin the subscription creation.
5962

60-
5. Event messages won't be sent until the Event Grid System Topic deployment has successfully completed. Upon successful creation of the Event Grid System Topic, the status of the workspace will change from "Updating" to "Succeeded".
63+
5. Event message sending can't occur until the Event Grid System Topic deployment has successfully completed. Upon successful creation of the Event Grid System Topic, the status of the workspace changes from **Updating** to **Succeeded**.
6164

6265
:::image type="content" source="media/events-deploy-in-portal/events-new-subscription-create.png" alt-text="Screenshot of an events subscription being deployed" lightbox="media/events-deploy-in-portal/events-new-subscription-create.png":::
6366

@@ -76,7 +79,7 @@ It's important that you have the following prerequisites completed before you be
7679
7780
## Next steps
7881

79-
In this article, you've learned how to deploy events in the Azure portal. For details about supported events, see [Azure Health Data Services as an Event Grid source](../../event-grid/event-schema-azure-health-data-services.md).
82+
In this article, you learned how to deploy Events in the Azure portal. For details about supported events, see [Azure Health Data Services as an Event Grid source](../../event-grid/event-schema-azure-health-data-services.md).
8083

8184
To learn how to enable the Events metrics, see
8285

articles/healthcare-apis/events/events-disable-delete-workspace.md

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,27 @@
11
---
22
title: Disable Events and delete workspaces - Azure Health Data Services
3-
description: This article provides resources on how to disable the Events service and delete workspaces.
3+
description: Learn how to disable the Events service and delete workspaces.
44
services: healthcare-apis
55
author: msjasteppe
66
ms.service: healthcare-apis
77
ms.subservice: fhir
88
ms.topic: how-to
9-
ms.date: 10/21/2022
9+
ms.date: 06/23/2022
1010
ms.author: jasteppe
1111
---
1212

1313
# How to disable Events and delete workspaces
1414

15-
In this article, you'll learn how to disable the Events feature and delete workspaces in the Azure Health Data Services.
15+
> [!NOTE]
16+
> [Fast Healthcare Interoperability Resources (FHIR®)](https://www.hl7.org/fhir/) is an open healthcare specification.
17+
18+
In this article, learn how to disable the Events feature and delete workspaces in the Azure Health Data Services.
1619

1720
## Disable Events
1821

1922
To disable Events from sending event messages for a single **Event Subscription**, the **Event Subscription** must be deleted.
2023

21-
1. Select the **Event Subscription** to be deleted. In this example, we'll be selecting an Event Subscription named **fhir-events**.
24+
1. Select the **Event Subscription** to be deleted. In this example, we select an Event Subscription named **fhir-events**.
2225

2326
:::image type="content" source="media/disable-delete-workspaces/events-select-subscription.png" alt-text="Screenshot of Events subscriptions and select event subscription to be deleted." lightbox="media/disable-delete-workspaces/events-select-subscription.png":::
2427

@@ -31,21 +34,21 @@ To disable Events from sending event messages for a single **Event Subscription*
3134
:::image type="content" source="media/disable-delete-workspaces/events-disable-no-subscriptions.png" alt-text="Screenshot of Events subscriptions and delete all event subscriptions to disable events." lightbox="media/disable-delete-workspaces/events-disable-no-subscriptions.png":::
3235

3336
> [!NOTE]
34-
> The Fast Healthcare Interoperability Resources (FHIR®) service will automatically go into an **Updating** status to disable the Events extension when a full delete of Event Subscriptions is executed. The FHIR service will remain online while the operation is completing.
37+
> The FHIR service will automatically go into an **Updating** status to disable the Events extension when a full delete of Event Subscriptions is executed. The FHIR service will remain online while the operation is completing.
3538
3639
## Delete workspaces
3740

38-
To successfully delete a workspace, delete all associated child resources first (for example: DICOM services, FHIR services and MedTech services), delete all Event Subscriptions, and then delete the workspace. Not deleting the child resources and Event Subscriptions first will cause an error when attempting to delete a workspace with child resources.
41+
To avoid errors and successfully delete workspaces, follow these steps and in this specific order:
3942

40-
As an example:
41-
42-
1. Delete all workspaces associated child resources - for example: DICOM service(s), FHIR service(s), and MedTech service(s).
43-
2. Delete all workspaces associated Event Subscriptions.
44-
3. Delete workspace.
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.
4546

4647
## Next steps
4748

48-
For more information about troubleshooting Events, see the Events troubleshooting guide:
49+
In this article, you learned how to disable Events and delete workspaces.
50+
51+
For more information about troubleshooting Events, see
4952

5053
> [!div class="nextstepaction"]
5154
> [Troubleshoot Events](events-troubleshooting-guide.md)

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

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,26 @@
11
---
22
title: Enable Events diagnostic settings for diagnostic logs and metrics export - Azure Health Data Services
3-
description: This article provides resources on how to enable Events diagnostic settings for diagnostic logs and metrics exporting.
3+
description: Learn how to enable Events diagnostic settings for diagnostic logs and metrics exporting.
44
services: healthcare-apis
55
author: msjasteppe
66
ms.service: healthcare-apis
77
ms.subservice: fhir
88
ms.topic: how-to
9-
ms.date: 10/21/2022
9+
ms.date: 06/23/2022
1010
ms.author: jasteppe
1111
---
1212

1313
# How to enable diagnostic settings for Events
1414

15-
In this article, you'll be provided resources to enable the Events diagnostic settings for Azure Event Grid system topics.
15+
> [!NOTE]
16+
> [Fast Healthcare Interoperability Resources (FHIR®)](https://www.hl7.org/fhir/) is an open healthcare specification.
1617
17-
After they're enabled, Event Grid system topics diagnostic logs and metrics will be exported to the destination of your choosing for audit, analysis, troubleshooting, or backup.
18+
In this article, learn how to enable the Events diagnostic settings for Azure Event Grid system topics.
1819

1920
## Resources
2021

2122
|Description|Resource|
22-
|----------------|--------|
23+
|-----------|--------|
2324
|Learn how to enable the Event Grid system topics diagnostic logging and metrics export feature.|[Enable diagnostic logs for Event Grid system topics](../../event-grid/enable-diagnostic-logs-topic.md#enable-diagnostic-logs-for-event-grid-system-topics)|
2425
|View a list of currently captured Event Grid system topics diagnostic logs.|[Event Grid system topic diagnostic logs](../../azure-monitor/essentials/resource-logs-categories.md#microsofteventgridsystemtopics)|
2526
|View a list of currently captured Event Grid system topics metrics.|[Event Grid system topic metrics](../../azure-monitor/essentials/metrics-supported.md#microsofteventgridsystemtopics)|

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ author: msjasteppe
66
ms.service: healthcare-apis
77
ms.subservice: fhir
88
ms.topic: reference
9-
ms.date: 06/16/2022
9+
ms.date: 06/23/2022
1010
ms.author: jasteppe
1111
---
1212

@@ -62,7 +62,7 @@ For a detailed description of the Events message structure and both required and
6262

6363
## What is the throughput for the Events messages?
6464

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 a workspace for all FHIR or DICOM service instances in it.
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.
6666

6767
## How am I charged for using Events?
6868

@@ -76,7 +76,7 @@ You can use the Event Grid filtering feature. There are unique identifiers in th
7676

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

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

8181
## Is Event Grid compatible with HIPAA and HITRUST compliance obligations?
8282

0 commit comments

Comments
 (0)