|
1 | 1 | --- |
2 | | -title: Configure Azure RBAC role for the FHIR service in Azure Health Data Services |
3 | | -description: Learn how to configure Azure RBAC for the FHIR service in Azure Health Data Services. Assign roles, manage access, and safeguard your data plane. |
| 2 | +title: Configure Azure RBAC role for Azure Health Data Services |
| 3 | +description: Learn how to configure Azure RBAC for FHIR and DICOM services in Azure Health Data Services. Assign roles and manage access to your data plane. |
4 | 4 | author: chachachachami |
5 | 5 | ms.service: azure-health-data-services |
6 | | -ms.topic: tutorial |
7 | | -ms.date: 06/02/2025 |
| 6 | +ms.topic: how-to |
| 7 | +ms.date: 03/27/2026 |
8 | 8 | ms.author: chrupa |
| 9 | +ms.reviewer: v-catheribun |
9 | 10 | ms.custom: sfi-image-nochange |
10 | 11 | --- |
11 | 12 | # Configure Azure RBAC roles for Azure Health Data Services |
12 | 13 |
|
13 | | -In this article, you learn how to use [Azure role-based access control (RBAC)](../role-based-access-control/index.yml) to assign access to the Azure Health Data Services data plane. Using Azure RBAC roles is the preferred method for assigning data plane access when data plane users are managed in the Microsoft Entra tenant associated with your Azure subscription. |
| 14 | +In this article, you learn how to use [Azure role-based access control (RBAC)](../role-based-access-control/index.yml) to assign permissions to the FHIR and DICOM service instances in Azure Health Data Services. |
14 | 15 |
|
15 | | -You can complete role assignments in the Azure portal. The FHIR® service and DICOM® service define application roles differently. Add or remove one or more roles to manage user access controls. |
| 16 | +Azure RBAC is an authorization system built on Azure Resource Manager that provides fine-grained access management of Azure resources. By using Azure RBAC, you can manage who has access to Azure resources, what they can do with those resources, and what areas they have access to. |
16 | 17 |
|
17 | | -## Assign roles for the FHIR service |
| 18 | +You can manage role assignments in the Azure portal for the FHIR® service and DICOM® service. |
18 | 19 |
|
19 | | -To grant users, service principals, or groups access to the FHIR data plane, go to the FHIR service in the Azure portal. Select **Access control (IAM)**, and then select the **Role assignments** tab. Select **+Add**, and then select **Add role assignment**. |
| 20 | +## RBAC roles for the FHIR and DICOM services |
20 | 21 |
|
21 | | -If the role assignment option is grayed out, ask your Azure subscription administrator to grant you with the permissions to the subscription or the resource group, for example, **User Access Administrator**. For more information, see [Azure built-in roles](../role-based-access-control/built-in-roles.md). |
| 22 | +Azure Health Data Services provides built-in roles for the FHIR and DICOM services. These roles provide granular access control to the data plane of each service. |
22 | 23 |
|
23 | | -:::image type="content" source="media/rbac/select-role-assignment.png" alt-text="Screenshot showing role assignment selection." lightbox="media/rbac/select-role-assignment.png"::: |
| 24 | +The built-in roles for the FHIR service include: |
24 | 25 |
|
25 | | -In the **Role** selection, search for one of the built-in roles for the FHIR data plane. You can choose from these roles: |
26 | | - |
27 | | -* **FHIR Data Reader**: Can read (and search) FHIR data. |
| 26 | +* **FHIR Data Reader**: Can read and search FHIR data. |
28 | 27 | * **FHIR Data Writer**: Can read, write, and soft delete FHIR data. |
29 | | -* **FHIR Data Exporter**: Can read and export ($export operator) data. |
| 28 | +* **FHIR Data Exporter**: Can read and export data by using the $export operator. |
30 | 29 | * **FHIR Data Contributor**: Can perform all data plane operations. |
31 | 30 | * **FHIR Data Converter**: Can use the converter to perform data conversion. |
32 | 31 | * **FHIR SMART User**: Can read and write FHIR data according to the SMART IG V1.0.0 specifications. |
33 | 32 |
|
34 | | -In the **Select** section, type the client application registration name. If the name is found, the application name is listed. Select the application name, and then select **Save**. |
35 | 33 |
|
36 | | -If the client application isn’t found, check your application registration. This is to ensure that the name is correct. Ensure that the client application is created in the same tenant where the FHIR service in Azure Health Data Services (hereby called the FHIR service) is deployed in. |
| 34 | +The built-in roles for the DICOM service include: |
| 35 | +* **DICOM Data Owner**: Full access to DICOM data. |
| 36 | +* **DICOM Data Reader**: Can read and search DICOM data. |
| 37 | + |
| 38 | +## Assign roles for the FHIR and DICOM services |
37 | 39 |
|
38 | | -:::image type="content" source="media/rbac/select-role-assignment.png" alt-text="Screenshot showing selection of role assignment." lightbox="media/rbac/select-role-assignment.png"::: |
| 40 | +Assign roles to users, service principals, or groups to grant them access to the FHIR and DICOM services. |
39 | 41 |
|
40 | | -You can verify the role assignment by selecting the **Role assignments** tab from the **Access control (IAM)** menu option. |
| 42 | +For the DICOM service, an application also must have the appropriate API permissions to access the DICOM service. For more information, see [Register a client application in Microsoft Entra ID for the Azure Health Data Services](./register-application.md). |
41 | 43 |
|
42 | | -## Assign roles for the DICOM service |
| 44 | +1. Go to your FHIR or DICOM service in the Azure portal. |
| 45 | +1. Select **Access control (IAM)**. |
| 46 | +1. Select **+ Add** > **Add role assignment**. |
| 47 | +1. Enter *DICOM* or *FHIR* in the search box, select one of the built-in roles for the service, and then select **Next**. |
43 | 48 |
|
44 | | -To grant users, service principals, or groups access to the DICOM data plane, select the **Access control (IAM)** blade. Select the**Role assignments** tab, and select **+ Add**. |
| 49 | + :::image type="content" source="media/rbac/select-role-assignment.png" alt-text="Screenshot of adding an Azure RBAC role assignment in the Azure portal." lightbox="media/rbac/select-role-assignment.png"::: |
45 | 50 |
|
46 | | -:::image type="content" source="media/rbac/dicom-access-control.png" alt-text="Screenshot showing DICOM access control." lightbox="media/rbac/dicom-access-control.png"::: |
| 51 | +1. On the **Members** tab, for **Assign access to**, select **User, group, or service principal**. |
| 52 | +1. Select **+ Select members** to search for a user, service principal, or group that you want to assign the role to. After you make your selection, select **Select**. |
47 | 53 |
|
48 | | -In the **Role** selection, search for one of the built-in roles for the DICOM data plane: |
| 54 | + :::image type="content" source="media/rbac/select-members.png" alt-text="Screenshot of selecting members for an Azure RBAC role assignment." lightbox="media/rbac/select-members.png"::: |
49 | 55 |
|
50 | | -:::image type="content" source="media/rbac/rbac-add-role-assignment.png" alt-text="Screenshot showing how to add an RBAC role assignment." lightbox="media/rbac/rbac-add-role-assignment.png"::: |
| 56 | +1. Select **Review + assign** to take you to the **Review and assign** tab. Review your selections, and then select **Review and assign** to finish the role assignment. |
51 | 57 |
|
52 | | -You can choose between: |
| 58 | + :::image type="content" source="media/rbac/assign-role.png" alt-text="Screenshot of reviewing and assigning an Azure RBAC role." lightbox="media/rbac/assign-role.png"::: |
53 | 59 |
|
54 | | -* DICOM Data Owner: Full access to DICOM data. |
55 | | -* DICOM Data Reader: Read and search DICOM data. |
| 60 | +To view your role assignments, select the **Role assignments** tab from the **Access control (IAM)** menu option. |
56 | 61 |
|
57 | | -If these roles aren’t sufficient, you can use PowerShell to create custom roles. For information about creating custom roles, see [Create a custom role by using Azure PowerShell](../role-based-access-control/custom-roles-powershell.md). |
| 62 | +:::image type="content" source="media/rbac/view-role-assignments.png" alt-text="Screenshot of viewing Azure RBAC role assignments in the Azure portal." lightbox="media/rbac/view-role-assignments.png"::: |
58 | 63 |
|
59 | | -In the **Select** box, search for a user, service principal, or group that you want to assign the role to. |
| 64 | +From this tab, you can select any role assignment to view more details about the assignment. You can also delete a role assignment from this tab by selecting the role assignment, and then selecting **Delete**. |
60 | 65 |
|
61 | 66 | > [!NOTE] |
62 | 67 | > If you can't access the FHIR or DICOM service in your application or other tools, you might need to wait a few more minutes for the role assignment to finish propagating in the system. |
63 | 68 |
|
64 | | -## Next steps |
65 | | - |
66 | | -[Access by using the REST Client](./fhir/using-rest-client.md) |
| 69 | +## Next step |
67 | 70 |
|
68 | | -[Access by using cURL](./fhir/using-curl.md) |
| 71 | +>[!div class="nextstepaction"] |
| 72 | +>[Access Azure Health Data Services](access-healthcare-apis.md) |
69 | 73 |
|
70 | 74 | [!INCLUDE [FHIR and DICOM trademark statement](./includes/healthcare-apis-fhir-dicom-trademark.md)] |
0 commit comments