Quickstart: Deploy the MedTech service using an Azure Resource Manager template and Azure PowerShell or the Azure CLI

Article
11/06/2023

To implement infrastructure as code for your Azure solutions, use Azure Resource Manager templates (ARM templates). The template is a JavaScript Object Notation (JSON) file that defines the infrastructure and configuration for your project. The template uses declarative syntax, which lets you state what you intend to deploy without having to write the sequence of programming commands to create it. In the template, you specify the resources to deploy and the properties for those resources.

In this quickstart, learn how to use Azure PowerShell or the Azure CLI to deploy an instance of the MedTech service using an Azure Resource Manager template (ARM template).

Tip

To learn more about ARM templates, see What are ARM templates?

Prerequisites

To begin your deployment and complete the quickstart, you must have the following prerequisites:

An active Azure subscription account. If you don't have an Azure subscription, see Subscription decision guide.
Owner or Contributor and User Access Administrator role assignments in the Azure subscription. For more information, see What is Azure role-based access control (Azure RBAC)?
The Microsoft.HealthcareApis and Microsoft.EventHub resource providers registered with your Azure subscription. To learn more about registering resource providers, see Azure resource providers and types.
Azure PowerShell and/or the Azure CLI installed locally.

When you have these prerequisites, you're ready to deploy the ARM template.

Review the ARM template

The ARM template used to deploy the resources in this quickstart is available at Azure Quickstart Templates by using the azuredeploy.json file on GitHub.

Deploy the MedTech service with the Azure Resource Manager template and Azure PowerShell

Complete the following five steps to deploy the MedTech service using Azure PowerShell:

Sign-in into Azure.
```
Connect-AzAccount
```
Set your Azure subscription deployment context using your subscription ID. To learn how to get your subscription ID, see Get subscription and tenant IDs in the Azure portal.
```
Set-AzContext <AzureSubscriptionId>
```
For example: Set-AzContext abcdef01-2345-6789-0abc-def012345678
Confirm the location you want to deploy in. See the Products available by region site for the current Azure regions where Azure Health Data Services is available.

You can also review the location section of the azuredeploy.json file.

If you need a list of the Azure regions location names, you can use this code to display a list:
```
Get-AzLocation | Format-Table -Property DisplayName,Location
```
If you don't already have a resource group created for this quickstart, you can use this code to create one:
```
New-AzResourceGroup -name <ResourceGroupName> -location <AzureRegion>
```
For example: New-AzResourceGroup -name ArmTestDeployment -location southcentralus

Important

For a successful deployment of the MedTech service, you'll need to use numbers and lowercase letters for the basename of your resources. The minimum basename requirement is three characters with a maximum of 16 characters.
Use the following code to deploy the MedTech service using the ARM template:
```
New-AzResourceGroupDeployment -ResourceGroupName <ResourceGroupName> -TemplateUri https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/quickstarts/microsoft.healthcareapis/workspaces/iotconnectors/azuredeploy.json -basename <BaseName> -location <AzureRegion>
```
For example: New-AzResourceGroupDeployment -ResourceGroupName ArmTestDeployment -TemplateUri https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/quickstarts/microsoft.healthcareapis/workspaces/iotconnectors/azuredeploy.json -basename abc123 -location southcentralus
Important

If you're going to allow access from multiple services to the event hub, it is highly recommended that each service has its own event hub consumer group.

Consumer groups enable multiple consuming applications to 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.

Examples:
- Two MedTech services accessing the same event hub.
- A MedTech service and a storage writer application accessing the same event hub.

Deploy the MedTech service with the Azure Resource Manager template and the Azure CLI

Complete the following five steps to deploy the MedTech service using the Azure CLI:

Sign-in into Azure.
```
az login
```
Set your Azure subscription deployment context using your subscription ID. To learn how to get your subscription ID, see Get subscription and tenant IDs in the Azure portal.
```
az account set <AzureSubscriptionId>
```
For example: az account set abcdef01-2345-6789-0abc-def012345678
Confirm the location you want to deploy in. See the Products available by region site for the current Azure regions where Azure Health Data Services is available.

You can also review the location section of the azuredeploy.json file.

If you need a list of the Azure regions location names, you can use this code to display a list:
```
az account list-locations -o table
```
If you don't already have a resource group created for this quickstart, you can use this code to create one:
```
az group create --resource-group <ResourceGroupName> --location <AzureRegion>
```
For example: az group create --resource-group ArmTestDeployment --location southcentralus

Important

For a successful deployment of the MedTech service, you'll need to use numbers and lowercase letters for the basename of your resources.
Use the following code to deploy the MedTech service using the ARM template:
```
az deployment group create --resource-group <ResourceGroupName> --template-uri https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/quickstarts/microsoft.healthcareapis/workspaces/iotconnectors/azuredeploy.json --parameters basename=<BaseName> location=<AzureRegion>
```
For example: az deployment group create --resource-group ArmTestDeployment --template-uri https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/quickstarts/microsoft.healthcareapis/workspaces/iotconnectors/azuredeploy.json --parameters basename=abc123 location=southcentralus
Important

If you're going to allow access from multiple services to the event hub, it is highly recommended that each service has its own event hub consumer group.

Consumer groups enable multiple consuming applications to 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.

Examples:
- Two MedTech services accessing the same event hub.
- A MedTech service and a storage writer application accessing the same event hub.

Review deployed resources and access permissions

When deployment is completed, the following resources and access roles are created in the ARM template deployment:

Azure Event Hubs namespace and event hub. In this deployment, the event hub is named devicedata.
- Event hub consumer group. In this deployment, the consumer group is named $Default.
- Azure Event Hubs Data Sender role. In this deployment, the sender role is named devicedatasender and can be used to provide access to the event hub using a shared access signature (SAS). To learn more about authorizing access using a SAS, see Authorizing access to Event Hubs resources using Shared Access Signatures.
Health Data Services workspace.
Health Data Services FHIR® service.
Health Data Services MedTech service with the required system-assigned managed identity roles:
- For the event hub, the Azure Events Hubs Data Receiver role is assigned in the Access control section (IAM) of the event hub.
- For the FHIR service, the FHIR Data Writer role is assigned in the Access control section (IAM) of the FHIR service.

Important

In this quickstart, the ARM template configures the MedTech service to operate in Create mode. A Patient resource and a Device resource are created for each device that sends data to your FHIR service.

To learn more about the MedTech service resolution types Create and Lookup, see Configure the Destination tab.

Post-deployment mappings

After you have successfully deployed an instance of the MedTech service, you'll still need to provide conforming and valid device and FHIR destination mappings.

To learn about the device mapping, see Overview of the MedTech service device mapping.
To learn about the FHIR destination mapping, see Overview of the FHIR destination mapping.

Clean up Azure PowerShell resources

When your resource group and deployed Bicep file resources are no longer needed, delete the resource group, which deletes the resources in the resource group.

Remove-AzResourceGroup -Name <ResourceGroupName>

For example: Remove-AzResourceGroup -Name ArmTestDeployment

Clean up the Azure CLI resources

When your resource group and deployed Bicep file resources are no longer needed, delete the resource group, which deletes the resources in the resource group.

az group delete --name <ResourceGroupName>

For example: az group delete --resource-group ArmTestDeployment

Tip

For a step-by-step tutorial that guides you through the process of creating an ARM template, see Tutorial: Create and deploy your first ARM template.

Next steps

Choose a deployment method for the MedTech service

Overview of the MedTech service device data processing stages

Frequently asked questions about the MedTech service

Note

FHIR® is a registered trademark of HL7 and is used with the permission of HL7.