Skip to content

Commit 42c473e

Browse files
Maggiemouse1Maggiemouse1
authored
Merge pull request #210343 from mcevoy-building7/medtech-deploy-8
Medtech deploy 8
2 parents 1179157 + 546a0f3 commit 42c473e

11 files changed

+970
-337
lines changed

‎articles/healthcare-apis/iot/deploy-02-new-button.md

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
---
2+
title: Deploy the MedTech service with a QuickStart template - Azure Health Data Services
3+
description: In this article, you'll learn how to deploy the MedTech service in the Azure portal using a QuickStart template.
4+
author: mcevoy-building7
5+
ms.service: healthcare-apis
6+
ms.subservice: fhir
7+
ms.topic: quickstart
8+
ms.date: 09/30/2022
9+
ms.author: v-smcevoy
10+
---
11+
12+
# Deploy the MedTech service with an Azure Resource Manager QuickStart template
13+
14+
In this article, you'll learn how to deploy the MedTech service in the Azure portal using an Azure Resource Manager (ARM) Quickstart template. This template will be used with the **Deploy to Azure** button to make it easy to provide the information you need to automatically set up the infrastructure and configuration of your deployment. For more information about Azure ARM templates, see [What are ARM templates?](../../azure-resource-manager/templates/overview.md).
15+
16+
If you need to see a diagram with information on the MedTech service deployment, there is an architecture overview at [Choose a deployment method](deploy-iot-connector-in-azure.md#deployment-architecture-overview). This diagram shows the data flow steps of deployment and how MedTech service processes data into a Fast Healthcare Interoperability Resource (FHIR) Observation.
17+
18+
There are four simple tasks you need to complete in order to deploy MedTech service with the ARM template **Deploy to Azure** button. They are:
19+
20+
## Prerequisites
21+
22+
In order to begin deployment, you need to have the following prerequisites:
23+
24+
- An active Azure subscription account. If you don't have an Azure subscription, see [Subscription decision guide](/azure/cloud-adoption-framework/decision-guides/subscriptions/).
25+
26+
- Two resource providers registered with your Azure subscription: **Microsoft.HealthcareApis** and **Microsoft.EventHub**. To learn more about registering resource providers, see [Azure resource providers and types](../../azure-resource-manager/management/resource-providers-and-types.md).
27+
28+
When you've fulfilled these two prerequisites, you are ready to begin the second task.
29+
30+
## Deploy to Azure button
31+
32+
Next, you need to select the ARM template **Deploy to Azure** button here:
33+
34+
[![Deploy to Azure](https://aka.ms/deploytoazurebutton)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FAzure%2Fazure-quickstart-templates%2Fmaster%2Fquickstarts%2Fmicrosoft.healthcareapis%2Fworkspaces%2Fiotconnectors%2Fazuredeploy.json).
35+
36+
This button will call a template from the Azure ARM QuickStart template library to get information from your Azure subscription environment and begin deploying the MedTech service.
37+
38+
After you select the **Deploy to Azure** button, it may take a few minutes to implement the following resources and roles:
39+
40+
- An Azure Event Hubs Namespace and device message Azure event hub. In this example, the event hub is named **devicedata**.
41+
42+
- An Azure event hub consumer group. In this example, the consumer group is named **$Default**.
43+
44+
- An Azure event hub sender role. In this example, the sender role is named **devicedatasender**.
45+
46+
- An Azure Health Data Services workspace.
47+
48+
- An Azure Health Data Services FHIR service.
49+
50+
- An Azure Health Data Services MedTech service instance, including the necessary [system-assigned managed identity](../../active-directory/managed-identities-azure-resources/overview.md) roles to the device message event hub (named **Azure Events Hubs Receiver**) and FHIR service (named **FHIR Data Writer**).
51+
52+
After these resources and roles have completed their implementation, the Azure portal will be launched.
53+
54+
## Provide configuration details
55+
56+
When the Azure portal screen appears, your next task is to fill out five fields that provide specific details of your deployment configuration.
57+
58+
:::image type="content" source="media\iot-deploy-quickstart-in-portal\iot-deploy-quickstart-options.png" alt-text="Screenshot of Azure portal page displaying deployment options for the Azure Health Data Service MedTech service." lightbox="media\iot-deploy-quickstart-in-portal\iot-deploy-quickstart-options.png":::
59+
60+
### Use these values to fill out the five fields
61+
62+
- **Subscription** - Choose the Azure subscription you want to use for the deployment.
63+
64+
- **Resource Group** - Choose an existing Resource Group or create a new Resource Group.
65+
66+
- **Region** - The Azure region of the Resource Group used for the deployment. This field will auto-fill, based on the Resource Group region.
67+
68+
- **Basename** - This value will be appended to the name of the Azure resources and services to be deployed.
69+
70+
- **Location** - Use the drop-down list to select a supported Azure region for the Azure Health Data Services (the value could be the same or different region than your Resource Group).
71+
72+
### When completed, do the following
73+
74+
Don't change the **Device Mapping** and **Destination Mapping** default values at this time.
75+
76+
Select the **Review + create** button after all the fields are filled out. This will review your input and check to see if all your values are valid.
77+
78+
When the validation is successful, select the **Create** button to begin the deployment. After a brief wait, a message will appear telling you that your deployment is complete.
79+
80+
## Required post-deployment tasks
81+
82+
Now that the MedTech service is successfully deployed, there are three post-deployment tasks that need to be completed before MedTech is fully functional and ready for use:
83+
84+
1. First, you must provide a working device mapping. For more information, see [How to use device mappings](how-to-use-device-mappings.md).
85+
86+
2. Second, you need to ensure that you have a working FHIR destination mapping. For more information, see [How to use FHIR destination mappings](how-to-use-fhir-mappings.md).
87+
88+
3. Third, you must use a Shared access policies (SAS) key (named **devicedatasender**) to connect your device or application to the MedTech service device message event hub (named **devicedata**). For more information, see [Connection string for a specific event hub in a namespace](../../event-hubs/event-hubs-get-connection-string.md#connection-string-for-a-specific-event-hub-in-a-namespace).
89+
90+
> [!IMPORTANT]
91+
>
92+
> If you're going to allow access from multiple services to the device message event hub, it is highly recommended that each service has its own event hub consumer group. 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).
93+
>
94+
> **Examples:**
95+
>
96+
> - Two MedTech services accessing the same device message event hub.
97+
> - A MedTech service and a storage writer application accessing the same device message event hub.
98+
99+
## Next steps
100+
101+
In this article, you learned how to deploy the MedTech service in the Azure portal using a Quickstart ARM template with a **Deploy to Azure** button. To learn more about other methods of deployment, see
102+
103+
>[!div class="nextstepaction"]
104+
>[Choosing a method of deployment for MedTech service in Azure](deploy-iot-connector-in-azure.md)
105+
106+
>[!div class="nextstepaction"]
107+
>[How to manually deploy MedTech service with Azure portal](deploy-03-new-manual.md)
108+
109+
>[!div class="nextstepaction"]
110+
>[How to deploy MedTech service using an ARM template and Azure PowerShell or Azure CLI](deploy-08-new-ps-cli.md)
111+
112+
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/iot/deploy-03-new-manual.md

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
---
2+
title: Overview of manually deploying the MedTech service using the Azure portal - Azure Health Data Services
3+
description: In this article, you'll see an overview of how to manually deploy the MedTech service in the Azure portal.
4+
author: mcevoy-building7
5+
ms.service: healthcare-apis
6+
ms.subservice: fhir
7+
ms.topic: quickstart
8+
ms.date: 09/30/2022
9+
ms.author: v-smcevoy
10+
---
11+
12+
# How to manually deploy MedTech service using the Azure portal
13+
14+
You may prefer to manually deploy MedTech service if you need to track every step of the developmental process. This might be necessary if you have to customize or troubleshoot your deployment. Manual deployment will help you by providing all the details for implementing each task.
15+
16+
The explanation of MedTech service manual deployment using the Azure portal is divided into three parts that cover each of key tasks required:
17+
18+
- Prerequisites (see Prerequisites below)
19+
- Configuration (see [Configure for manual deployment](./deploy-05-new-config.md))
20+
- Deployment and Post Deployment (see [Manual deployment and post-deployment](./deploy-06-new-deploy.md))
21+
22+
If you need a diagram with information on the MedTech service deployment, there is an architecture overview at [Choose a deployment method](deploy-iot-connector-in-azure.md#deployment-architecture-overview). This diagram shows the data flow steps of deployment and how MedTech service processes data into a Fast Healthcare Interoperability Resource (FHIR) Observation.
23+
24+
## Prerequisites
25+
26+
Before you can begin configuring to deploy MedTech services, you need to have the following five prerequisites:
27+
28+
- A valid Azure subscription
29+
- A resource group deployed in the Azure portal
30+
- A workspace deployed in Azure Health Data Services
31+
- An event hub deployed in a namespace
32+
- FHIR service deployed in Azure Health Data Services
33+
34+
## Open your Azure account
35+
36+
The first thing you need to do is determine if you have a valid Azure subscription. If you don't have an Azure subscription, see [Subscription decision guide](/azure/cloud-adoption-framework/decision-guides/subscriptions/).
37+
38+
## Deploy a resource group in the Azure portal
39+
40+
When you log in to your Azure account, go to Azure portal and select the Create a resource button. Then enter "Azure Health Data Services" in the "Search services and marketplace" box. This should take you to the Azure Health Data Services page.
41+
42+
## Deploy a workspace in Azure Health Data Services
43+
44+
The first resource you must create is a workspace to contain your Azure Health Data Services resources. Start by selecting Create from the Azure Health Data Services resource page. This will take you to the first page of Create Azure Health Data Services workspace, when you need to do the following 8 steps:
45+
46+
1. Fill in the resource group you want to use or create a new one.
47+
48+
2. Give the workspace a unique name.
49+
50+
3. Select the region you want to use.
51+
52+
4. Select the Networking button at the bottom to continue.
53+
54+
5. Choose whether you want a public or private endpoint.
55+
56+
6. Create tags if you want to use them. They are optional.
57+
58+
7. When you are ready to continue, select the Review + create tab.
59+
60+
8. Select the Create button to deploy your workspace.
61+
62+
After a short delay, you will start to see information about your new workspace. Make sure you wait until all parts of the screen are displayed. If your initial deployment was successful, you should see:
63+
64+
- "Your deployment is complete"
65+
- Deployment name
66+
- Subscription name
67+
- Resource group name
68+
69+
## Deploy an event hub in the Azure portal using a namespace
70+
71+
An event hub is the next prerequisite you need to create. It is important because it receives the data flow from a medical device and stores it there until MedTech can pick up the data and translate it into a FHIR service Observation resource. Because Internet propagation times are indeterminate, the event hub is needed to buffer the data and store it for as much as 24 hours before expiring.
72+
73+
Before you can create an event hub, you must create a namespace in Azure portal to contain it. For more information on how To create a namespace and an event hub, see [Azure Event Hubs namespace and event hub deployed in the Azure portal](../../event-hubs/event-hubs-create.md).
74+
75+
## Deploy the FHIR service
76+
77+
The last prerequisite you need to do before you can configure and deploy MedTech service, is to deploy the FHIR service.
78+
79+
There are three ways to deploy FHIR service:
80+
81+
1. Using portal. See [Deploy a FHIR service within Azure Health Data Services - using portal](../fhir/fhir-portal-quickstart.md).
82+
83+
2. Using Bicep. See [Deploy a FHIR service within Azure Health Data Services using Bicep](../fhir/fhir-service-bicep.md).
84+
85+
3. Using an ARM template. See [Deploy a FHIR service within Azure Health Data Services - using ARM template](../fhir/fhir-service-resource-manager-template.md).
86+
87+
After you have deployed FHIR service, it will be ready to receive the data processed by MedTech and persist it as a FHIR service Observation.
88+
89+
## Next steps
90+
91+
In this article, you learned about the prerequisites needed to deploy the MedTech service manually. When you have completed all the prerequisite requirements and your FHIR service is deployed, you are ready for the next step of manual deployment, see
92+
93+
>[!div class="nextstepaction"]
94+
>[Configure the MedTech service for manual deployment using the Azure portal](deploy-05-new-config.md)
95+
96+
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/iot/deploy-04-new-prereq.md

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
---
2+
title: Prerequisites for deploying the MedTech service manually using the Azure portal - Azure Health Data Services
3+
description: In this article, you'll learn the prerequisites for manually deploying the MedTech service in the Azure portal.
4+
author: mcevoy-building7
5+
ms.service: healthcare-apis
6+
ms.subservice: fhir
7+
ms.topic: quickstart
8+
ms.date: 09/27/2022
9+
ms.author: v-smcevoy
10+
---
11+
12+
# Prerequisites for manually deploying the MedTech service using the Azure portal
13+
14+
Before you can configure or deploy MedTech services, you need to have the following five prerequisites:
15+
16+
- A valid Azure subscription
17+
- A resource group deployed in the Azure portal
18+
- A workspace deployed in Azure Health Data Services
19+
- An event hub deployed in a namespace
20+
- FHIR service deployed in Azure Health Data Services
21+
22+
## Open your Azure account
23+
24+
The first thing you need to do is determine if you have a valid Azure subscription. If you don't have an Azure subscription, see [Subscription decision guide](/azure/cloud-adoption-framework/decision-guides/subscriptions/).
25+
26+
## Deploy a resource group in the Azure portal
27+
28+
When you log in to your Azure account, go to Azure portal and select the Create a resource button. Then enter "Azure Health Data Services" in the "Search services and marketplace" box. You should take you to the Azure Health Data Services blade.
29+
30+
## Deploy a workspace in Azure Health Data Services
31+
32+
The first resource you must create is a workspace to contain your Azure Health Data Services resources.
33+
34+
Start by selecting Create from the Azure Health Data Services resource page. This will take you to the first page of Create Azure Health Data Services workspace, when you need to do the following 8 steps:
35+
36+
1. Fill in the resource group you want to use or create a new one.
37+
38+
2. Give the workspace a unique name.
39+
40+
3. Select the region you want to use.
41+
42+
4. Select the Networking button at the bottom to continue.
43+
44+
5. Choose whether you want a public or private endpoint.
45+
46+
6. Create tags if you want to use them.
47+
48+
7. When you are ready to move forward, select the Review + create tab.
49+
50+
8. Select the Create button to deploy your workspace.
51+
52+
After a short delay, you will start to see information about your new workspace. Make sure you wait until all parts of the screen are displayed. If your initial deployment was successful, you should see:
53+
54+
- "Your deployment is complete"
55+
- Deployment name
56+
- Subscription name
57+
- Resource group name
58+
59+
## Deploy an event hub in the Azure portal using a namespace
60+
61+
An event hub is the next prerequisite you need to create. It is important because it receives the data flow from a medical device and stores it there until MedTech can pick up the data and translate it into a FHIR service Observation resource. Because Internet propagation times are indeterminate, the event hub is needed to buffer the data and store it for as much as 24 hours before expiring.
62+
63+
Before you can create an event hub, you must create a namespace in Azure portal to contain it. For more information on how To create a namespace and an event hub, see [Azure Event Hubs namespace and event hub deployed in the Azure portal](../../event-hubs/event-hubs-create.md).
64+
65+
## Deploy the FHIR service
66+
67+
The last thing you need to do before you can configure and deploy MedTech service is to deploy the FHIR service.
68+
69+
There are three ways to deploy FHIR service:
70+
71+
1. Using portal. See [Deploy a FHIR service within Azure Health Data Services - using portal](../fhir/fhir-portal-quickstart.md).
72+
73+
2. Using Bicep. See [Deploy a FHIR service within Azure Health Data Services using Bicep](../fhir/fhir-service-bicep.md).
74+
75+
3. Using an ARM template. See [Deploy a FHIR service within Azure Health Data Services - using ARM template](../fhir/fhir-service-resource-manager-template.md).
76+
77+
After you have deployed FHIR service, it will be ready to take the data processed by MedTech and persist it as a FHIR service Observation.
78+
79+
## Next steps
80+
81+
In this article, you learned about the prerequisites needed to deploy the MedTech service manually. When you have completed all the prerequisite requirements and your FHIR service is deployed, you are ready for the next step of manual deployment, see
82+
83+
>[!div class="nextstepaction"]
84+
>[Configure the MedTech service for manual deployment using the Azure portal](deploy-05-new-config.md)
85+
86+
FHIR® is a registered trademark of Health Level Seven International, registered in the U.S. Trademark Office and is used with their permission.

0 commit comments

Comments
 (0)