Skip to content

Commit 1389424

Browse files
authored
Merge pull request #206705 from mcevoy-building7/medtech-get-started-match-diagram
Medtech get started match diagram
2 parents b065037 + 8872529 commit 1389424

File tree

1 file changed

+107
-20
lines changed

1 file changed

+107
-20
lines changed

articles/healthcare-apis/iot/get-started-with-iot.md

Lines changed: 107 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -5,40 +5,54 @@ author: mcevoy-building7
55
ms.service: healthcare-apis
66
ms.subservice: fhir
77
ms.topic: quickstart
8-
ms.date: 07/19/2022
8+
ms.date: 08/02/2022
99
ms.author: v-smcevoy
1010
ms.custom: mode-api
1111
---
1212

1313
# Get started with the MedTech service in the Azure Health Data Services
1414

15-
This article outlines the basic steps to get started with the Azure MedTech service in the [Azure Health Data Services](../healthcare-apis-overview.md). The MedTech service ingests health data from a medical device using the Azure Event Hubs service. It then persists the data to the Azure Fast Healthcare Interoperability Resources (FHIR®) service as Observation resources. This data processing procedure makes it possible to link FHIR service Observations to patient and device resources.
15+
This article will show you how to get started with the Azure MedTech service in the [Azure Health Data Services](../healthcare-apis-overview.md). There are six steps you need to follow to be able to deploy and process MedTech service to ingest health data from a medical device using Azure Event Hubs service, persist the data to Azure Fast Healthcare Interoperability Resources (FHIR®) service as Observation resources, and link FHIR service Observations to patient and device resources. This article provides an architecture overview to help you follow the six steps of the implementation process.
1616

17-
The following diagram shows the four-step data flow that enables the MedTech service to receive data from a device and send it to the FHIR service.
17+
## Architecture overview of MedTech service
1818

19-
- Step 1 introduces the subscription and permissions prerequisites needed.
19+
The following diagram outlines the basic architectural path that enables the MedTech service to receive data from a medical device and send it to the FHIR service. This diagram shows how the six-step implementation process is divided into three key development stages: deployment, post-deployment, and data processing.
2020

21-
- Step 2 shows how Azure services are provisioned for the MedTech services.
21+
[![Diagram showing MedTech service architectural overview.](media/iot-get-started/get-started-with-iot.png)](media/iot-get-started/get-started-with-iot.png#lightbox)
2222

23-
- Step 3 represents the flow of data sent from devices to the event hub and the MedTech service.
23+
### Deployment
2424

25-
- Step 4 demonstrates the path needed to verify data sent to the FHIR service.
25+
- Step 1 introduces the subscription and permissions prerequisites required.
2626

27-
[![MedTech service data flow diagram.](media/iot-get-started/get-started-with-iot.png)](media/iot-get-started/get-started-with-iot.png#lightbox)
27+
- Step 2 shows how Azure services are provisioned for MedTech services.
2828

29-
Follow these four steps and you'll be able to deploy the MedTech service effectively:
29+
- Step 3 presents the configuration process.
3030

31-
## Step 1: Prerequisites for using the Azure Health Data Services
31+
### Post-deployment
3232

33-
Before you can begin sending data from a device, you need to determine if you have the appropriate Azure subscription and Azure RBAC (Role-Based Access Control) roles. If you already have the appropriate subscription and roles, you can skip this step.
33+
- Step 4 outlines how to connect to other services.
34+
35+
### Data processing
36+
37+
- Step 5 represents the data flow from a device to an event hub and is processed through the five parts of the MedTech service.
38+
39+
- Step 6 demonstrates the path to verify processed data sent from MedTech service to the FHIR service.
40+
41+
## Get started implementing MedTech service
42+
43+
Follow these six steps to set up and start using MedTech service.
44+
45+
## Step 1: Prerequisites for deployment
46+
47+
In order to begin deployment, you need to determine if you have: an Azure subscription and correct Azure RBAC (Role-Based Access Control) role assignments. If you already have the appropriate subscription and roles, you can skip this step.
3448

3549
- If you don't have an Azure subscription, see [Subscription decision guide](/azure/cloud-adoption-framework/decision-guides/subscriptions/).
3650

3751
- You must have the appropriate RBAC roles for the subscription resources you want to use. The roles required for a user to complete the provisioning would be Contributor AND User Access Administrator OR Owner. The Contributor role allows the user to provision resources, and the User Access Administrator role allows the user to grant access so resources can send data between them. The Owner role can perform both. For more information, see [Azure role-based access control](/azure/cloud-adoption-framework/ready/considerations/roles).
3852

39-
## Step 2: Provision services and obtain permissions
53+
## Step 2: Provision services for deployment
4054

41-
After obtaining the required prerequisites, you must create a workspace and provision instances of the Event Hubs service, FHIR service, and MedTech service. You must also give the Event Hubs permission to read data from your device and give the MedTech service permission to read and write to the FHIR service.
55+
After obtaining the required prerequisites, the next phase of deployment is to create a workspace and provision instances of the Event Hubs service, FHIR service, and MedTech service. You must also give the Event Hubs permission to read data from your device and give the MedTech service permission to read and write to the FHIR service. There are four parts of this provisioning process.
4256

4357
### Create a resource group and workspace
4458

@@ -59,25 +73,98 @@ You must provision a [FHIR service](../fhir/fhir-portal-quickstart.md) instance
5973

6074
Once the FHIR service is provisioned, you must give the MedTech service permission to read and write to FHIR service. This permission enables the data to be persisted in the FHIR service store using system-assigned managed identity. See details on how to assign the **FHIR Data Writer** role to the MedTech service from the [FHIR service](deploy-iot-connector-in-azure.md#granting-access-to-the-fhir-service).
6175

62-
By design, the MedTech service retrieves data from the specified event hub using the system-assigned managed identity. For more information on how to assign the role to the MedTech service from [Event Hubs](deploy-iot-connector-in-azure.md#granting-access-to-the-device-message-event-hub).
76+
By design, the MedTech service retrieves data from the specified event hub using the system-assigned managed identity. For more information on how to assign the role to the MedTech service from [Event Hubs](deploy-iot-connector-in-azure.md#granting-access-to-the-device-message-event-hub).
6377

6478
### Provision a MedTech service instance in the workspace
6579

6680
You must provision a MedTech service instance from the [Azure portal](deploy-iot-connector-in-azure.md) in your workspace. You can make the provisioning process easier and more efficient by automating everything with Azure PowerShell, Azure CLI, or Azure REST API. You can find automation scripts at the [Azure Health Data Services samples](https://github.com/microsoft/healthcare-apis-samples/tree/main/src/scripts) website.
6781

6882
The MedTech service persists the data to the FHIR store using the system-managed identity. See details on how to assign the role to the MedTech service from the [FHIR service](deploy-iot-connector-in-azure.md#granting-access-to-the-fhir-service).
6983

70-
## Step 3: Send the data
84+
## Step 3: Configure MedTech for deployment
85+
86+
After you have fulfilled the prerequisites and provisioned your services, the next phase of deployment is to configure MedTech services to ingest data, set up device mappings, and set up destination mappings. These configuration settings will ensure that the data can be translated from your device to Observations in the FHIR service. There are four parts in this configuration process.
87+
88+
### Configuring MedTech service to ingest data
89+
90+
MedTech service must be configured to ingest data it will receive from an event hub. First you must begin the official deployment process at the Azure portal. For more information about configuring MedTech service using the Azure portal, see [Deployment using the Azure portal](deploy-iot-connector-in-azure.md#prerequisites).
91+
92+
Once you have starting using the portal and added MedTech service to your workspace, you must then configure MedTech service to ingest data from an event hub. For more information about configuring MedTech service to ingest data, see [Configure the MedTech service to ingest data](deploy-iot-connector-in-azure.md#configure-the-medtech-service-to-ingest-data).
93+
94+
### Configuring device mappings
95+
96+
You must configure MedTech to map it to the device you want to receive data from. Each device has unique settings that MedTech service must use. For more information on how to use Device mappings, see [How to use Device mappings](./how-to-use-device-mappings.md).
97+
98+
- Azure Health Data Services provides an open source tool you can use called [IoMT Connector Data Mapper](https://github.com/microsoft/iomt-fhir/tree/main/tools/data-mapper) that will help you map your device's data structure to a form that MedTech can use. For more information on device content mapping, see [Device Content Mapping](https://github.com/microsoft/iomt-fhir/blob/main/docs/Configuration.md#device-content-mapping).
99+
100+
- When you are deploying MedTech service, you must set specific device mapping properties. For more information on device mapping properties, see [Configure the Device mapping properties](deploy-iot-connector-in-azure.md#configure-the-device-mapping-properties).
101+
102+
### Configuring destination mappings
103+
104+
Once your device's data is properly mapped to your device's data format, you must then map it to an Observation in the FHIR service. For an overview of FHIR destination mappings, see [How to use the FHIR destination mappings](how-to-use-fhir-mappings.md).
105+
106+
For step-by-step destination property mapping, see [Configure destination properties](deploy-iot-connector-in-azure.md#configure-destination-properties
107+
).
108+
109+
### Create and deploy the MedTech service
110+
111+
If you have completed the prerequisites, provisioning, and configuration, you are now ready to deploy the MedTech service. Create and deploy your MedTech service by following deployment the procedure at [Create your MedTech service](deploy-iot-connector-in-azure.md#create-your-medtech-service).
112+
113+
## Step 4: Connect to required services (post deployment)
114+
115+
When you complete the final [deployment procedure](deploy-iot-connector-in-azure.md#create-your-medtech-service) and don't get any errors, you must link MedTech service to an Event Hubs and the FHIR service. This will enable a connection from MedTech service to an Event Hubs instance and the FHIR service, so that data can flow smoothly from device to FHIR Observation. In order to do this, the Event Hubs instance for device message flow must be granted access via role assignment, so MedTech service can receive Event Hubs data. You must also grant access to The FHIR service via role assignments in order for MedTech to receive the data. There are two parts of the process to connect to required services.
116+
117+
For more information about granting access via role assignments, see [Granting the MedTech service access to the device message event hub and FHIR service](deploy-iot-connector-in-azure.md#granting-the-medtech-service-access-to-the-device-message-event-hub-and-fhir-service).
118+
119+
### Granting access to the device message event hub
120+
121+
The Event Hubs instance for device message event hub must be granted access using managed identity in order for the MedTech service to receive data sent to the event hub from a device. The step-by-step procedure for doing this is at [Granting access to the device message event hub](deploy-iot-connector-in-azure.md#granting-access-to-the-device-message-event-hub).
122+
123+
For more information about authorizing access to Event Hubs resources, see [Authorize access with Azure Active Directory](../../event-hubs/authorize-access-azure-active-directory.md).
124+
125+
For more information about application roles, see [Authentication and Authorization for Azure Health Data Services](../authentication-authorization.md).
126+
127+
### Granting access to FHIR service
128+
129+
You must also grant access via role assignments to the FHIR service. This will enable FHIR service to receive data from the MedTech service by granting access using managed identity. The step-by-step procedure for doing this is at [Granting access to the FHIR service](deploy-iot-connector-in-azure.md#granting-access-to-the-fhir-service).
130+
131+
For more information about assigning roles to the FHIR services, see [Configure Azure RBAC role for Azure Health Data Services](../configure-azure-rbac.md).
132+
133+
For more information about application roles, see [Authentication and Authorization for Azure Health Data Services](../authentication-authorization.md).
134+
135+
## Step 5: Send the data for processing
136+
137+
When MedTech service is deployed and connected to the Event Hubs and FHIR services, it is ready to process data from a device and translate it into a FHIR service Observation. There are three parts of the sending process.
138+
139+
### Data sent from Device to Event Hubs
140+
141+
The data is sent to an Event Hub instance so that it can wait until MedTech service is ready to receive it. The data transfer needs to be asynchronous because it is sent over the Internet and delivery times cannot be precisely measured. Normally the data won't sit on an event hub longer than 24 hours.
142+
143+
For more information about Event Hubs, see [Event Hubs](../../event-hubs/event-hubs-about.md).
144+
145+
For more information on Event Hubs data retention, see [Event Hubs quotas](../../event-hubs/event-hubs-quotas.md)
146+
147+
### Data Sent from Event Hubs to MedTech
148+
149+
MedTech requests the data from the Event Hubs instance and the data is sent from the event hub to MedTech. This procedure is called ingestion.
150+
151+
### MedTech processes the data
152+
153+
MedTech processes the data in five steps:
71154

72-
When the relevant services are provisioned, you can send event data from the device to MedTech service using an event hub. The event data is routed in the following manner:
155+
- Ingest
156+
- Normalize
157+
- Group
158+
- Transform
159+
- Persist
73160

74-
- Data is sent from your device to the event hub.
161+
If the processing was successful and you did not get any error messages, your device data is now a FHIR service [Observation](http://hl7.org/fhir/observation.html) resource.
75162

76-
- After the data is received by the event hub, MedTech service reads it. Then it transforms the data into a FHIR service [Observation](http://hl7.org/fhir/observation.html) resource using the data mapping you supplied.
163+
For more details on the data flow through MedTech, see [MedTech service data flow](iot-data-flow.md).
77164

78-
## Step 4: Verify the data
165+
## Step 6: Verify the processed data
79166

80-
If the data isn't mapped or if the mapping isn't authored properly, the data is skipped. If there are no problems with the [device mapping](./how-to-use-device-mappings.md) or the [FHIR destination mapping](how-to-use-fhir-mappings.md), the data is persisted in the FHIR service.
167+
You can verify that the data was processed correctly by checking to see if there is now a new Observation resource in the FHIR service. If the data isn't mapped or if the mapping isn't authored properly, the data will be skipped. If there are any problems, check the [device mapping](how-to-use-device-mappings.md) or the [FHIR destination mapping](how-to-use-fhir-mappings.md).
81168

82169
### Metrics
83170

0 commit comments

Comments
 (0)