Skip to content

Commit d8e666c

Browse files
authored
Merge pull request #194423 from msjasteppe/medtech-deploy-updates
Adding section about Consumer Groups and edits.
2 parents fe958be + 40d89af commit d8e666c

File tree

1 file changed

+26
-17
lines changed

1 file changed

+26
-17
lines changed

articles/healthcare-apis/iot/deploy-iot-connector-in-azure.md

Lines changed: 26 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -5,24 +5,33 @@ author: msjasteppe
55
ms.service: healthcare-apis
66
ms.subservice: fhir
77
ms.topic: quickstart
8-
ms.date: 03/21/2022
8+
ms.date: 04/07/2022
99
ms.author: jasteppe
1010
ms.custom: mode-api
1111
---
1212

1313
# Deploy MedTech service in the Azure portal
1414

15-
In this quickstart, you'll learn how to deploy MedTech service in the Azure portal. Configuring the MedTech service will enable you to ingest data from Internet of Things (IoT) into your Fast Healthcare Interoperability Resources (FHIR®) service using an Azure Event Hub for device messages.
15+
In this quickstart, you'll learn how to deploy MedTech service in the Azure portal. The MedTech service will enable you to ingest data from Internet of Things (IoT) into your Fast Healthcare Interoperability Resources (FHIR®) service.
1616

1717
## Prerequisites
1818

19-
It's important that you have the following prerequisites completed before you begin the steps of creating an MedTech service instance in Azure Health Data Services.
19+
It's important that you have the following prerequisites completed before you begin the steps of creating a MedTech service instance in Azure Health Data Services.
2020

2121
* [Azure account](https://azure.microsoft.com/free/search/?OCID=AID2100131_SEM_c4b0772dc7df1f075552174a854fd4bc:G:s&ef_id=c4b0772dc7df1f075552174a854fd4bc:G:s&msclkid=c4b0772dc7df1f075552174a854fd4bc)
2222
* [Resource group deployed in the Azure portal](../../azure-resource-manager/management/manage-resource-groups-portal.md)
23-
* [Event Hubs namespace and Event Hub deployed in the Azure portal](../../event-hubs/event-hubs-create.md)
23+
* [Event Hubs namespace and event hub deployed in the Azure portal](../../event-hubs/event-hubs-create.md)
2424
* [Workspace deployed in Azure Health Data Services](../healthcare-apis-quickstart.md)
25-
* [FHIR service deployed in Azure Health Data Services](../fhir/fhir-portal-quickstart.md)
25+
* [FHIR service deployed in Azure Health Data Services](../fhir/fhir-portal-quickstart.md)
26+
27+
> [!IMPORTANT]
28+
> If you're going to allow access from multiple services to the device message event hub, it is highly recommended that each service have its own event hub consumer group.
29+
>
30+
> Consumer groups enable multiple consuming applications to each have a separate view of the event stream, and to read the stream independently at their own pace and with their own offsets. For more information, see, [Consumer groups](../../event-hubs/event-hubs-features.md#consumer-groups).
31+
>
32+
> Examples:
33+
>* Two MedTech services accessing the same device message event hub.
34+
>* A MedTech service and a storage writer application accessing the same device message event hub.
2635
2736
## Deploy MedTech service
2837

@@ -50,9 +59,9 @@ Under the **Basics** tab, complete the required fields under **Instance details*
5059

5160
2. Enter the **Event Hub name**.
5261

53-
The Event Hub name is the name of the **Event Hubs Instance** that you've deployed.
62+
The event hub name is the name of the **Event Hubs Instance** that you've deployed.
5463

55-
For information about Azure Event Hubs, see [Quickstart: Create an Event Hub using Azure portal](../../event-hubs/event-hubs-create.md#create-an-event-hubs-namespace).
64+
For information about Azure Event Hubs, see [Quickstart: Create an event hub using Azure portal](../../event-hubs/event-hubs-create.md#create-an-event-hubs-namespace).
5665

5766
3. Enter the **Consumer Group**.
5867

@@ -112,11 +121,11 @@ Under the **Destination** tab, enter the destination properties associated with
112121
113122
**Create**
114123

115-
The MedTech service destination attempts to retrieve a device resource from the FHIR Server using the device identifier included in the Event Hub message. It also attempts to retrieve a patient resource from the FHIR Server using the patient identifier included in the Event Hub message. If either resource isn't found, new resources will be created (device, patient, or both) containing just the identifier contained in the Event Hub message. When you use the **Create** option, both a device identifier and a patient identifier can be configured in the device mapping. In other words, when the IoT Connector destination is in **Create** mode, it can function normally **without** adding device and patient resources to the FHIR Server.
124+
The MedTech service destination attempts to retrieve a device resource from the FHIR Server using the device identifier included in the event hub message. It also attempts to retrieve a patient resource from the FHIR Server using the patient identifier included in the event hub message. If either resource isn't found, new resources will be created (device, patient, or both) containing just the identifier contained in the event hub message. When you use the **Create** option, both a device identifier and a patient identifier can be configured in the device mapping. In other words, when the IoT Connector destination is in **Create** mode, it can function normally **without** adding device and patient resources to the FHIR Server.
116125

117126
**Lookup**
118127

119-
The MedTech service destination attempts to retrieve a device resource from the FHIR Server using the device identifier included in the event hub message. If the device resource isn't found, this will cause an error, and the data won't be processed. For **Lookup** to function properly, a device resource with an identifier matching the device identifier included in the event hub message **must** exist and the device resource **must** have a reference to a patient resource that also exists. In other words, when the MedTech service destination is in the Lookup mode, device and patient resources **must** be added to the FHIR Server before data can be processed.
128+
The MedTech service destination attempts to retrieve a device resource from the FHIR service using the device identifier included in the event hub message. If the device resource isn't found, an error will occur, and the data won't be processed. For **Lookup** to function properly, a device resource with an identifier matching the device identifier included in the event hub message **must** exist and the device resource **must** have a reference to a patient resource that also exists. In other words, when the MedTech service destination is in the Lookup mode, device and patient resources **must** be added to the FHIR Server before data can be processed.
120129

121130
For more information, see the open source documentation [FHIR destination mapping](https://github.com/microsoft/iomt-fhir/blob/master/docs/Configuration.md#fhir-mapping).
122131

@@ -151,13 +160,13 @@ Under the **Tags** tab, enter the tag properties associated with the MedTech ser
151160

152161
![Screenshot of Deployed MedTech service listed in the Azure Recent resources list.](media/azure-resources-iot-connector-deployed.png#lightbox)
153162

154-
Now that your MedTech service has been deployed, we're going to walk through the steps of assigning permissions to access the Event Hub and FHIR service.
163+
Now that your MedTech service has been deployed, we're going to walk through the steps of assigning permissions to access the event hub and FHIR service.
155164

156165
## Granting MedTech service access
157166

158-
To ensure that your MedTech service works properly, it must have granted access permissions to the Event Hub and FHIR service.
167+
To ensure that your MedTech service works properly, it must have granted access permissions to the event hub and FHIR service.
159168

160-
### Accessing the MedTech service from the Event Hub
169+
### Accessing the MedTech service from the event hub
161170

162171
1. In the **Azure Resource group** list, select the name of your **Event Hubs Namespace**.
163172

@@ -173,7 +182,7 @@ To ensure that your MedTech service works properly, it must have granted access
173182

174183
![Screenshot of add role assignment required fields.](media/event-hub-add-role-assignment-fields.png#lightbox)
175184

176-
The Azure Event Hubs Data Receiver role allows the MedTech service that's being assigned this role to receive data from this Event Hub.
185+
The Azure Event Hubs Data Receiver role allows the MedTech service that's being assigned this role to receive data from this event hub.
177186

178187
For more information about application roles, see [Authentication & Authorization for Azure Health Data Services](.././authentication-authorization.md).
179188

@@ -183,11 +192,11 @@ To ensure that your MedTech service works properly, it must have granted access
183192

184193
`<your workspace name>/iotconnectors/<your MedTech service name>`
185194

186-
When you deploy an MedTech service, it creates a managed identity. The managed identify name is a concatenation of the workspace name, resource type (that's the MedTech service), and the name of the MedTech service.
195+
When you deploy a MedTech service, it creates a managed identity. The managed identify name is a concatenation of the workspace name, resource type (that's the MedTech service), and the name of the MedTech service.
187196

188197
7. Select **Save**.
189198

190-
After the role assignment has been successfully added to the Event Hub, a notification will display a green check mark with the text "Add Role assignment." This message indicates that the MedTech service can now read from the Event Hub.
199+
After the role assignment has been successfully added to the event hub, a notification will display a green check mark with the text "Add Role assignment." This message indicates that the MedTech service can now read from the event hub.
191200

192201
![Screenshot of added role assignment message.](media/event-hub-added-role-assignment.png#lightbox)
193202

@@ -221,9 +230,9 @@ For more information about authoring access to Event Hubs resources, see [Author
221230

222231
## Next steps
223232

224-
In this article, you've learned how to deploy an MedTech service in the Azure portal. For an overview of MedTech service, see
233+
In this article, you've learned how to deploy a MedTech service in the Azure portal. For an overview of MedTech service, see
225234

226235
>[!div class="nextstepaction"]
227236
>[MedTech service overview](iot-connector-overview.md)
228237
229-
(FHIR&#174;) is a registered trademark of [HL7](https://hl7.org/fhir/) and is used with the permission of HL7.
238+
FHIR&#174; is a registered trademark of [HL7](https://hl7.org/fhir/) and is used with the permission of HL7.

0 commit comments

Comments
 (0)