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/fhir/migration-faq.md
+16-15Lines changed: 16 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ ms.date: 9/27/2023
14
14
15
15
## When will Azure API for FHIR be retired?
16
16
17
-
Azure API for FHIR will be retired on September 30, 2026.
17
+
Azure API for FHIR® will be retired on September 30, 2026.
18
18
19
19
## Are new deployments of Azure API for FHIR allowed?
20
20
@@ -28,28 +28,29 @@ Azure API for FHIR is a service that was purpose built for protected health info
28
28
29
29
Azure Health Data Service FHIR service offers a rich set of capabilities such as:
30
30
31
-
- Consumption-based pricing model where customers pay only for used storage and throughput
32
-
- Support for transaction bundles
33
-
- Chained search improvements
34
-
- Improved ingress and egress of data with \$import, \$export including new features such as incremental import
35
-
- Events to trigger new workflows when FHIR resources are created, updated or deleted
36
-
- Connectors to Azure Synapse Analytics, Power BI and Azure Machine Learning for enhanced analytics
31
+
- Consumption-based pricing model where customers pay only for used storage and throughput.
32
+
- Support for transaction bundles.
33
+
- Chained search improvements.
34
+
- Improved ingress and egress of data with `$import`, and `$export`, including new features such as incremental import.
35
+
- Events to trigger new workflows when FHIR resources are created, updated, or deleted.
36
+
- Connectors to Azure Synapse Analytics, Power BI and Azure Machine Learning for enhanced analytics.
37
37
38
38
## What are the steps to enable SMART on FHIR in Azure Health Data Service FHIR service?
39
39
40
-
SMART on FHIR proxy is retiring. Organizations need to transition to the SMART on FHIR (Enhanced), which uses Azure Health Data and AI OSS samples by **September 21, 2026**. After September 21, 2026, applications relying on SMART on FHIR proxy will report errors when accessing the FHIR service.
40
+
The SMART on FHIR proxy is retiring. Organizations need to transition to the SMART on FHIR (Enhanced), which uses Azure Health Data and AI OSS samples, by **September 21, 2026**. After September 21, 2026, applications relying on SMART on FHIR proxy will report errors when accessing the FHIR service.
41
41
42
-
SMART on FHIR (Enhanced) provides more capabilities than SMART on FHIR proxy and meets requirements in the SMART on FHIR Implementation Guide (v 1.0.0) and §170.315(g)(10) Standardized API for patient and population services criterion.
42
+
SMART on FHIR (Enhanced) provides more capabilities than SMART on FHIR proxy, and meets requirements in the SMART on FHIR Implementation Guide (v 1.0.0) and §170.315(g)(10) Standardized API for patient and population services criterion.
43
43
44
44
## What will happen after the service is retired on September 30, 2026?
45
45
46
46
After September 30, 2026 customers won't be able to:
47
47
48
-
- Create or manage Azure API for FHIR accounts
49
-
- Access the data through the Azure portal or APIs/SDKs/client tools
50
-
- Receive service updates to Azure API for FHIR or APIs/SDKs/client tools
51
-
- Access customer support (phone, email, web)
52
-
- Where can customers go to learn more about migrating to Azure Health Data Services FHIR service?
48
+
- Create or manage Azure API for FHIR accounts.
49
+
- Access the data through the Azure portal or APIs/SDKs/client tools.
50
+
- Receive service updates to Azure API for FHIR or APIs/SDKs/client tools.
51
+
- Access customer support (phone, email, web).
52
+
53
+
## Where can customers go to learn more about migrating to Azure Health Data Services FHIR service?
53
54
54
55
Start with [migration strategies](migration-strategies.md) to learn more about Azure API for FHIR to Azure Health Data Services FHIR service migration. The migration from Azure API for FHIR to Azure Health Data Services FHIR service involves data migration and updating the applications to use Azure Health Data Services FHIR service. Find more documentation on the step-by-step approach to migrating your data and applications in the [migration tool](https://github.com/Azure/apiforfhir-migration-tool/blob/main/lift-and-shift-resources/Liftandshiftresources_README.md).
55
56
@@ -60,4 +61,4 @@ Check out these resources if you need further assistance:
60
61
- Get answers from community experts in [Microsoft Q&A](/answers/questions/1377356/retirement-announcement-azure-api-for-fhir).
61
62
- If you have a support plan and require technical support, [contact us](https://ms.portal.azure.com/#view/Microsoft_Azure_Support/HelpAndSupportBlade/~/overview).
Azure Health Data Services FHIR service is the next-generation platform for health data integration. It offers managed, enterprise-grade FHIR, DICOM, and MedTech services for diverse health data exchange.
17
+
Azure Health Data Services FHIR® service is the next-generation platform for health data integration. It offers managed, enterprise-grade FHIR, DICOM, and MedTech services for diverse health data exchange.
18
18
19
19
When you migrate your FHIR data from Azure API for FHIR to Azure Health Data Services FHIR service, your organization can benefit from improved performance, scalability, security, and compliance. Organizations can also access new features and capabilities that aren't available in Azure API for FHIR.
20
20
21
21
Azure API for FHIR will be retired on September 30, 2026, so you need to migrate your FHIR data to Azure Health Data Services FHIR service as soon as feasible. To make the process easier, we created some tools and tips to help you assess your readiness, prepare your data, migrate your applications, and cut over to the new service.
22
22
23
23
## Recommended approach
24
24
25
-
To migrate your data, follow these steps:
25
+
To migrate your data, follow these steps.
26
26
27
27
- Step 1: Assess readiness
28
28
- Step 2: Prepare to migrate
@@ -36,10 +36,10 @@ Compare the differences between Azure API for FHIR and Azure Health Data Service
36
36
|Capabilities|Azure API for FHIR|Azure Health Data Services|
|**Settings**|Supported: <br> • Local RBAC <br> • SMART on FHIR Proxy|Planned deprecation: <br> • Local RBAC (9/6/23) <br> • SMART on FHIR Proxy (9/21/26)|
39
-
|**Data storage Volume**|More than 4 TB|Current support is 4 TB (Open an [Azure support request](../../azure-portal/supportability/how-to-create-azure-support-request.md) if you need more than 4 TB)|
40
-
|**Data ingress**|Tools available in OSS|$import operation|
39
+
|**Data storage Volume**|More than 4 TB|Current support is 4 TB. Open an [Azure support request](../../azure-portal/supportability/how-to-create-azure-support-request.md) if you need more than 4 TB|
40
+
|**Data ingress**|Tools available in OSS|`$import` operation|
41
41
|**Autoscaling**|Supported on request and incurs charge|Enabled by default at no extra charge|
42
-
|**Search parameters**|Bundle type supported: Batch <br> • Include and revinclude, iterate modifier not supported <br> • Sorting supported by first name, last name, birthdate and clinical date|Bundle type supported: Batch and transaction <br> • Selectable search parameters <br> • Include, revinclude, and iterate modifier is supported <br>• Sorting supported by string and dateTime fields|
42
+
|**Search parameters**|Bundle type supported: Batch <br> • Include and revinclude, iterate modifier not supported <br> • Sorting supported by first name, family name, birthdate and clinical date|Bundle type supported: Batch and transaction <br> • Selectable search parameters <br> • Include, revinclude, and iterate modifier is supported <br>• Sorting supported by string and dateTime fields|
43
43
|**Events**|Not Supported|Supported|
44
44
|**Infrastructure**|Supported: <br> • Customer managed keys <br> • Cross region DR (disaster recovery) <br>|Supported: <br> • PITR (point in time recovery) <br> • [Customer managed keys](configure-customer-managed-keys.md) <br> Upcoming: <br> • Availability zone support|
45
45
@@ -53,18 +53,18 @@ Compare the differences between Azure API for FHIR and Azure Health Data Service
53
53
54
54
-**Azure Health Data Services FHIR service does not support local RBAC and custom authority**. The token issuer authority needs to be the authentication endpoint for the tenant that the FHIR Service is running in.
55
55
56
-
-**The IoT connector is only supported using an Azure API for FHIR service**. The IoT connector is succeeded by the MedTech service. You need to deploy a MedTech service and corresponding FHIR service within an existing or new Azure Health Data Services workspace and point your devices to the new Azure Events Hubs device event hub. Use the existing IoT connector device and destination mapping files with the MedTech service deployment.
56
+
-**The IoT connector is only supported using an Azure API for FHIR service**. The IoT connector is succeeded by the MedTech service. You need to deploy a MedTech service and corresponding FHIR service within an existing or new Azure Health Data Services workspace, and point your devices to the new Azure Events Hubs device event hub. Use the existing IoT connector device and destination mapping files with the MedTech service deployment.
57
57
58
58
If you want to migrate existing IoT connector device FHIR data from your Azure API for FHIR service to the Azure Health Data Services FHIR service, use the bulk export and import functionality in the migration tool. Another migration path would be to deploy a new MedTech service and replay the IoT device messages through the MedTech service.
59
59
60
60
## Step 2: Prepare to migrate
61
61
62
-
First, create a migration plan. We recommend the migration patterns described in the table. Depending on your organization’s tolerance for downtime, you may decide to use certain patterns and tools to help facilitate your migration.
62
+
First, create a migration plan. We recommend the migration patterns described in the following table. Depending on your organization’s tolerance for downtime, you may decide to use certain patterns and tools to help facilitate your migration.
63
63
64
64
|Migration pattern|Details|How?|
65
65
|-----------------|-------|----|
66
-
|**Lift and shift**|The simplest pattern. Ideal if your data pipeline can afford longer downtime.|Choose the option that works best for your organization: <br> • Configure a workflow to [\$export](../azure-api-for-fhir/export-data.md) your data on Azure API for FHIR, and then [\$import](configure-import-data.md) into Azure Health Data Services FHIR service. <br> • The [GitHub repo](https://github.com/Azure/apiforfhir-migration-tool/blob/main/lift-and-shift-resources/Liftandshiftresources_README.md) provides tips on running these commands, and a script to help automate creating the \$import payload. <br> • Or create your own tool to migrate the data using \$export and \$import.|
67
-
|**Incremental copy**|Continuous version of lift and shift, with less downtime. Ideal for large amounts of data that take longer to copy, or if you want to continue running Azure API for FHIR during the migration.|Choose the option that works best for your organization. <br> • We created an [OSS migration tool](https://github.com/Azure/apiforfhir-migration-tool/tree/main/FHIR-data-migration-tool-docs) to help with this migration pattern. <br> • Or create your own tool to migrate the data incrementally.|
66
+
|**Lift and shift**|The simplest pattern. Ideal if your data pipeline can afford longer downtime.|Choose the option that works best for your organization: <br> • Configure a workflow to [$export](../azure-api-for-fhir/export-data.md) your data on Azure API for FHIR, and then [$import](configure-import-data.md) into Azure Health Data Services FHIR service. <br> • The [GitHub repo](https://github.com/Azure/apiforfhir-migration-tool/blob/main/lift-and-shift-resources/Liftandshiftresources_README.md) provides tips on running these commands, and a script to help automate creating the `$import` payload. <br> • Create your own tool to migrate the data using `$export` and `$import`.|
67
+
|**Incremental copy**|Continuous version of lift and shift, with less downtime. Ideal for large amounts of data that take longer to copy, or if you want to continue running Azure API for FHIR during the migration.|Choose the option that works best for your organization. <br> • We created an [OSS migration tool](https://github.com/Azure/apiforfhir-migration-tool/tree/main/FHIR-data-migration-tool-docs) to help with this migration pattern. <br> • Create your own tool to migrate the data incrementally.|
68
68
69
69
### OSS migration tool considerations
70
70
@@ -80,7 +80,7 @@ Identify data to migrate.
80
80
Deploy a new Azure Health Data Services FHIR Service server.
81
81
- First, deploy an Azure Health Data Services workspace.
82
82
83
-
- Then deploy an Azure Health Data Services FHIR Service server. More information: [Deploy a FHIR service within Azure Health Data Services](fhir-portal-quickstart.md)
83
+
- Then deploy an Azure Health Data Services FHIR Service server. More information is found here: [Deploy a FHIR service within Azure Health Data Services](fhir-portal-quickstart.md).
84
84
85
85
- Configure your new Azure Health Data Services FHIR Service server. If you need to use the same configurations as you have in Azure API for FHIR for your new server, see the recommended list of what to check for in the [migration tool documentation](https://github.com/Azure/apiforfhir-migration-tool/blob/main/FHIR-data-migration-tool-docs/Appendix.md). Configure the settings before you migrate.
86
86
@@ -96,12 +96,14 @@ Migrate applications that were pointing to the old FHIR server.
96
96
97
97
- Set up permissions again for [these apps](/azure/storage/blobs/assign-azure-role-data-access).
98
98
99
-
-Reconfigure any remaining settings in the new Azure Health Data Services FHIR Service server after migration.
99
+
-After migration, reconfigure any remaining settings in the new Azure Health Data Services FHIR service server.
100
100
101
-
- If you’d like to double check to make sure that the Azure Health Data Services FHIR Service and Azure API for FHIR servers have the same configurations, you can check both [metadata endpoints](use-postman.md#get-the-capability-statement) to compare and contrast the two servers.
101
+
- If you’d like to double check that the Azure Health Data Services FHIR service and Azure API for FHIR servers have the same configurations, you can check both [metadata endpoints](use-postman.md#get-the-capability-statement) to compare the two servers.
102
102
103
-
- Set up any jobs that were previously running in your old Azure API for FHIR server (for example, \$export jobs)
103
+
- Set up any jobs that were previously running in your old Azure API for FHIR server (for example, `$export` jobs)
104
104
105
105
## Step 5: Cut over to Azure Health Data Services FHIR services
106
106
107
-
After you’re confident that your Azure Health Data Services FHIR Service server is stable, you can begin using Azure Health Data Services FHIR service to satisfy your business scenarios. Turn off any remaining pipelines that are running on Azure API for FHIR, delete data from the intermediate storage account that was used in the migration tool if necessary, delete data from your Azure API for FHIR server, and decommission your Azure API for FHIR account.
107
+
After you’re confident that your Azure Health Data Services FHIR Service server is stable, you can begin using Azure Health Data Services FHIR service to satisfy your business scenarios. Turn off any remaining pipelines that are running on Azure API for FHIR. If necessary, delete data from the intermediate storage account that was used in the migration tool. Delete data from your Azure API for FHIR server, and decommission your Azure API for FHIR account.
0 commit comments