You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/healthcare-apis/iot/get-started-with-iot.md
+39-45Lines changed: 39 additions & 45 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,47 +12,47 @@ ms.custom: mode-api
12
12
13
13
# Get started with the MedTech service in the Azure Health Data Services
14
14
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 through the implementation process.
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.
16
16
17
-
## MedTech service architecture overview
17
+
## Architecture overview of MedTech service
18
18
19
-
The following diagram shows 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 show how the six-step implementation process is divided into the three development stages: deployment, post-deployment, and data processing.
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.
20
20
21
21
[](media/iot-get-started/get-started-with-iot.png#lightbox)
22
22
23
23
### Deployment
24
24
25
-
- Step 1 introduces the subscription and permissions prerequisites needed.
25
+
- Step 1 introduces the subscription and permissions prerequisites required.
26
26
27
-
- Step 2 shows how Azure services are provisioned for the MedTech services.
27
+
- Step 2 shows how Azure services are provisioned for MedTech services.
28
28
29
29
- Step 3 presents the configuration process.
30
30
31
31
### Post-deployment
32
32
33
-
- Step 4 outlines how to connect to services.
33
+
- Step 4 outlines how to connect to other services.
34
34
35
35
### Data processing
36
36
37
-
- Step 5 represents how data flows from A device to an event hub and then is processed through the 5 parts of the MedTech service.
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
38
39
-
- Step 6 demonstrates the path needed to verify data sent from MedTech service to the FHIR service.
39
+
- Step 6 demonstrates the path to verify processed data sent from MedTech service to the FHIR service.
40
40
41
41
## Get started implementing MedTech service
42
42
43
-
The following six development steps will enable you to set up and start using MedTech service.
43
+
Follow these six steps to set up and start using MedTech service.
44
44
45
45
## Step 1: Prerequisites for deployment
46
46
47
-
In order to begin deployment, you need to determine if you have the appropriates: an Azure subscription and correct Azure RBAC (Role-Based Access Control) roles. If you already have the appropriate subscription and roles, you can skip this step.
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.
48
48
49
49
- If you don't have an Azure subscription, see [Subscription decision guide](/azure/cloud-adoption-framework/decision-guides/subscriptions/).
50
50
51
51
- 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).
52
52
53
53
## Step 2: Provision services for deployment
54
54
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.
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.
56
56
57
57
### Create a resource group and workspace
58
58
@@ -73,7 +73,7 @@ You must provision a [FHIR service](../fhir/fhir-portal-quickstart.md) instance
73
73
74
74
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).
75
75
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).
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).
77
77
78
78
### Provision a MedTech service instance in the workspace
79
79
@@ -83,50 +83,44 @@ The MedTech service persists the data to the FHIR store using the system-managed
83
83
84
84
## Step 3: Configure MedTech for deployment
85
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.
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
87
88
88
### Configuring MedTech service to ingest data
89
89
90
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#prerequisites).
91
91
92
-
<!--The link above needs to go to a new head in Deployment that needs to be created to introduce the portal.-->
93
-
94
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#configure-the-medtech-service-to-ingest-data).
95
93
96
94
### Configuring device mappings
97
95
98
-
You must configure MedTech to map to the needs of 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).
99
-
100
-
#### IoMT Connector Data Mapper
101
-
102
-
Fortunately 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).
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).
103
97
104
-
#### Configuring devicemapping properties for deployment
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).
105
99
106
-
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#configure-the-device-mapping-properties).
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#configure-the-device-mapping-properties).
107
101
108
102
### Configuring destination mappings
109
103
110
-
Once your device's data is properly mapped to your device's data format, you must also 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).
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).
111
105
112
106
For step-by-step destination property mapping, see [Configure destination properties](deploy-iot-connector-in-azure#configure-destination-properties
113
-
)
107
+
).
114
108
115
-
For more technical details on FHIR destination mappings, see [FHIR Mapping](https://github.com/microsoft/iomt-fhir/blob/main/docs/Configuration.md#fhir-mapping)
109
+
For more technical details on FHIR destination mappings, see [FHIR Mapping](https://github.com/microsoft/iomt-fhir/blob/main/docs/Configuration.md#fhir-mapping).
116
110
117
-
### Ready to deploy
111
+
### Create and deploy the MedTech service
118
112
119
-
If you have done the three steps of 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#create-your-medtech-service).
113
+
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#create-your-medtech-service).
120
114
121
-
## Step 4: Connect to services post deployment
115
+
## Step 4: Connect to required services (post deployment)
122
116
123
-
When you complete the final [deployment procedure](deploy-iot-connector-in-azure#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 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.
117
+
When you complete the final [deployment procedure](deploy-iot-connector-in-azure#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.
124
118
125
-
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#granting-the-medtech-service-access-to-the-device-message-event-hub-and-fhir-service)
119
+
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#granting-the-medtech-service-access-to-the-device-message-event-hub-and-fhir-service).
126
120
127
121
### Granting access to the device message event hub
128
122
129
-
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#granting-access-to-the-device-message-event-hub)
123
+
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#granting-access-to-the-device-message-event-hub).
130
124
131
125
For more information about authorizing access to Event Hubs resources, see [Authorize access with Azure Active Directory](https://docs.microsoft.com/en-us/azure/event-hubs/authorize-access-azure-active-directory).
132
126
@@ -142,37 +136,37 @@ For more information about application roles, see [Authentication and Authorizat
142
136
143
137
## Step 5: Send the data for processing
144
138
145
-
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.
139
+
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.
146
140
147
-
### Data from Device to Event Hubs
141
+
### Data sent from Device to Event Hubs
148
142
149
143
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.
150
144
151
-
For more information about Event Hubs, see [https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-about](https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-about).
145
+
For more information about Event Hubs, see [Event Hubs](../../event-hubs/event-hubs-about.md).
152
146
153
-
For more information on Event Hubs data retention, see [What is the maximum retention period for events?](https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-faq#what-is-the-maximum-retention-period-for-events-).
147
+
For more information on Event Hubs data retention, see [Event Hubs quotas](../../event-hubs/event-hubs-quotas)
154
148
155
-
### Data from Event Hubs to MedTech
149
+
### Data Sent from Event Hubs to MedTech
156
150
157
-
MedTech requests the data from the Event Hubs instance. This is called ingestion.
151
+
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.
158
152
159
153
### MedTech processes the data
160
154
161
155
MedTech processes the data in five steps:
162
156
163
-
-ingest
164
-
-normalize
165
-
-group
166
-
-transform
167
-
-persist
157
+
-Ingest
158
+
-Normalize
159
+
-Group
160
+
-Transform
161
+
-Persist
168
162
169
-
For more details on the data flow through MedTech, see [MedTech service data flow](iot-data-flow.md).
163
+
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.
170
164
171
-
If all went well, your device data is now a FHIR service [Observation](http://hl7.org/fhir/observation.html) resource.
165
+
For more details on the data flow through MedTech, see [MedTech service data flow](iot-data-flow.md).
172
166
173
167
## Step 6: Verify the processed data
174
168
175
-
You can verify the processed data by seeing if it is an 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 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 as an Observation resource.
169
+
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).
0 commit comments