Skip to content

Commit a1ea63e

Browse files
shellyhaverkampshellyhaverkamp
committed
2 files
1 parent ae9e10d commit a1ea63e

File tree

2 files changed

+158
-0
lines changed

2 files changed

+158
-0
lines changed

‎articles/healthcare-apis/fhir/migration-faq.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
title: Migration FAQ
3+
description: Find answers to your questions about migrating FHIR data from Azure API for FHIR to the Azure Health Data Services FHIR service.
4+
services: healthcare-apis
5+
ms.service: healthcare-apis
6+
ms.subservice: fhir
7+
ms.topic: tutorial
8+
ms.author: evach
9+
author: evachen96
10+
ms.date: 9/27/2023
11+
---
12+
13+
# FAQ about migration from Azure API for FHIR
14+
15+
## When will Azure API for FHIR be retired?
16+
17+
Azure API for FHIR will be retired on September 30, 2026.
18+
19+
## Are new deployments of Azure API for FHIR allowed?
20+
21+
Due to the transition from Azure API for FHIR to Azure Health Data Services, after April 1, 2025 customers won't be able to create new deployments of Azure API of FHIR. Until April 1, 2025 new deployments are allowed.
22+
23+
## Why is Microsoft retiring Azure API for FHIR?
24+
25+
Azure API for FHIR is a service that was purpose built for protected health information (PHI), meeting regional compliance requirements. In March 2022, we announced the general availability of Azure Health Data Services, which enables quick deployment of managed, enterprise-grade FHIR, DICOM, and MedTech services for diverse health data integration. With this new experience, we’re retiring Azure API for FHIR.
26+
27+
## What are the benefits of migrating to Azure Health Data Services FHIR service?
28+
29+
AHDS FHIR service offers a rich set of capabilities such as:
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 (preview)
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+
38+
## What are the steps to enable SMART on FHIR in Azure Health Data Service FHIR service?
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.
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.
43+
44+
## What will happen after the service is retired on September 30, 2026?
45+
46+
After September 30, 2026 customers won't be able to:
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?
53+
54+
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 this [migration tool](https://github.com/Azure/apiforfhir-migration-tool/blob/main/v0/V0_README.md).

‎articles/healthcare-apis/fhir/migration-strategies.md

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
---
2+
title: Migration strategies
3+
description: Learn how to migrate FHIR data from Azure API for FHIR to the Azure Health Data Services FHIR service. This article provides steps and tools for a smooth transition.
4+
services: healthcare-apis
5+
ms.service: healthcare-apis
6+
ms.subservice: fhir
7+
ms.topic: tutorial
8+
ms.author: evach
9+
author: evachen96
10+
ms.date: 9/27/2023
11+
---
12+
13+
# Migration strategies for moving from Azure API for FHIR
14+
15+
[!INCLUDE [retirement banner](../includes/healthcare-apis-azure-api-fhir-retirement.md)]
16+
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+
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+
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+
23+
## Recommended approach
24+
25+
To migrate your data, follow these steps:
26+
27+
- Step 1: Assess readiness
28+
- Step 2: Prepare to migrate
29+
- Step 3: Migrate data and application workloads
30+
- Step 4: Cut over from Azure API for FHIR to Azure Health Data Services
31+
32+
## Step 1: Assess readiness
33+
34+
Compare the differences between Azure API for FHIR and Azure Health Data Services. Also review your architecture and assess if any changes need to be made.
35+
36+
|---**Capabilities** |---**Azure API for FHIR** |---**Azure Health Data Services** |
37+
| **Settings** | Supported: Local RBAC • SMART on FHIR Proxy | Planned deprecation - Local RBAC (9/6/23) - SMART on FHIR Proxy (9/21/26) | | |
38+
| **Data storage Volume** | More than 4 TB | Current support is 4 TB. Reach out to CSS team if you need more than 4 TB. | | |
39+
| **Data ingress** | Tools available in OSS | $import operation | | |
40+
| **Autoscaling** | Supported on request and incurs charge | Enabled by default at no extra charge | | |
41+
| **Search parameters** | - Bundle type supported: Batch - Include and revinclude, iterate modifier not supported - Sorting supported by first name, last name, birthdate and clinical date | - Bundle Type supported: Batch and transaction - Selectable search parameters - Include, revinclude, and iterate modifier is supported - Sorting supported by string and dateTime fields | | |
42+
| **Events** | Not Supported | Supported | | |
43+
| **Infrastructure** | Supported: - Customer managed keys - AZ support and PITR - Cross region DR | Supported - Data recovery - Upcoming: AZ support for customer managed keys | | |
44+
45+
### Things to consider that may affect your architecture
46+
47+
- **Sync agent is being deprecated**. If you're using sync agent to connect to Dataverse, see [Overview of data integration toolkit](/dynamics365/industry/healthcare/data-integration-toolkit-overview?toc=%2Findustry%2Fhealthcare%2Ftoc.json&bc=%2Findustry%2Fbreadcrumb%2Ftoc.json)
48+
49+
- **FHIR Proxy is being deprecated**. If you're using FHIR Proxy for events, refer to the built-in [eventing](../events/events-overview.md/) feature. Alternatives can be customized and built using the [Azure Health Data Services toolkit](https://github.com/microsoft/azure-health-data-services-toolkit).
50+
51+
- **SMART on FHIR proxy is being deprecated**. You need to use the new SMART on FHIR capability. More information: [SMART on FHIR](smart-on-fhir.md)
52+
53+
- **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.
54+
55+
- **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+
57+
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.
58+
59+
## Step 2: Prepare to migrate
60+
61+
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+
63+
| Migration Pattern | Details | How? |
64+
|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
65+
| Lift and shift | The simplest pattern. Ideal if your data pipelines can afford longer downtime. | Choose the option that works best for your organization: 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. The [GitHub repo](https://github.com/Azure/apiforfhir-migration-tool/blob/main/v0/V0_README.md) provides tips on running these commands, and a script to help automate creating the \$import payload. Or, create your own tool to migrate the data using \$export and \$import. |
66+
| 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. We created an [OSS migration tool](https://github.com/Azure/apiforfhir-migration-tool/blob/main/v0/V0_README.md) to help with this migration pattern. Or, create your own tool to migrate the data incrementally.
67+
68+
### OSS migration tool considerations
69+
70+
If you decide to use the OSS migration tool, review and understand the migration tool’s [capabilities and limitations](https://github.com/Azure/apiforfhir-migration-tool/incremental-copy-docs/appendix.md).
71+
#### Prepare Azure API for FHIR server
72+
Identify data to migrate.
73+
- Take this opportunity to clean up data or FHIR servers that you no longer use.
74+
75+
- Decide if you want to migrate historical versions or not.
76+
77+
Deploy a new Azure Health Data Services FHIR Service server.
78+
- First, deploy an Azure Health Data Services workspace.
79+
80+
- Then deploy an Azure Health Data Services FHIR Service server ([Deploy a FHIR service within Azure Health Data Services](fhir-portal-quickstart.md)
81+
82+
- 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 [migration tool documentation](https://microsoft.sharepoint.com/:w:/t/msh/Eb7WohSv_6JNlG1xAI8TyvoBbAPfhxnPzr4wv9py1InEww?e=QeSbo3&nav=eyJoIjoiMTUwODIzNzMifQ)). Configure the settings before you migrate.
83+
84+
## Step 3: Migrate data
85+
86+
Choose the migration pattern that works best for your organization. If you're using OSS migration tools, follow the instructions on [GitHub](https://github.com/Azure/apiforfhir-migration-tool).
87+
88+
## Step 4: Migrate applications and reconfigure settings
89+
90+
Migrate applications that were pointing to the old FHIR server.
91+
92+
- Change the endpoints on your applications so that they point to the new FHIR server’s URL.
93+
94+
- Set up permissions again for [these apps](/azure/storage/blobs/assign-azure-role-data-access).
95+
96+
- Reconfigure any remaining settings in the new Azure Health Data Services FHIR Service server after migration.
97+
98+
- 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-capability-statement) to compare and contrast the two servers.
99+
100+
- Set up any jobs that were previously running in your old Azure API for FHIR server (for example, \$export jobs)
101+
102+
## Step 5: Cut over to Azure Health Data Services FHIR services
103+
104+
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.

0 commit comments

Comments
 (0)