This respository is a set of OSS tools that helps you migrate your data from Azure API for FHIR to the new evolved version, Azure Health Data Services FHIR Service. Please find more information below:
- Learn more about Azure Health Data Services capabilities here.
- Learn more about the overall recommended migration strategies approach here prior to starting migration.
We recommend the following migration patterns. Depending on your organization’s tolerance for downtime, you may choose to use certain migration patterns and tools to help facilitate your migration.
| Migration Pattern | Details | How? |
|---|---|---|
| Lift and Shift | The simplest pattern. Ideal if your data pipelines can afford large downtime. Downtime: Your Azure API for FHIR instance will need to be read-only during the entire duration of the migration. |
Choose the option that works best for your organization: • Configure a workflow to $export your data on Azure API for FHIR, then $import into Azure Health Data Services FHIR Service. You can create your own tool to migrate the data using $export and $import. • The Github repo has some tips on running these commands, as well as a script to help automate creating the $import payload here. |
| FHIR data migration tool | 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. Downtime: Your Azure API for FHIR instance can remain read/write during the migration. Then, before cutover, there will be a short downtime where Azure API for FHIR will need to be read-only for the last incremental copy. |
Choose the option that works best for your organization: • You can create your own tool to migrate the data in an continuous fashion. • We have created an OSS FHIR data migration tool that can help with this migration pattern. |
This repo provides resources for each of these migration patterns.
At a high level, this migration pattern involves:
- Stop all writes to Azure API for FHIR.
- Move data from Azure API for FHIR to Azure Health Data Services FHIR service.
- Once migration is complete, cutover and point all applications and workloads to the new Azure Health Data Services FHIR service.
- Decommission Azure API for FHIR.
- Review overall migration strategies here.
- Review configurations that you may want to set up in your new Azure Health Data Services FHIR Server here.
- Configure a workflow to $export your data on Azure API for FHIR, then $import into Azure Health Data Services FHIR Service. The Github repo has some tips on running these commands, as well as a script to help automate creating the $import payload in the "Lift and Shift" folder here. Or, you can create your own tool to migrate the data using $export and $import.
The OSS migration tool is an Azure Durable Function-based tool layered on top of existing FHIR server $export and $import functionality to orchestrate one-way migration of FHIR data. It continuously migrates new data to give you time to test your new FHIR server with your data, and flexibility to align your cutover with your organization’s existing maintenance windows.
At a high level, this migration pattern involves:
- Start moving chunks of data from Azure API for FHIR to Azure Health Data Services. The Azure API for FHIR can continue having new writes during this process.
- Continuously copy new data from Azure API for FHIR to Azure Health Data Services.
- After a majority of the data has been copied, stop all writes to Azure API for FHIR. Wait for the final $export/$imports to complete.
- Cutover and point all applications and workloads to the new Azure Health Data Services FHIR service.
- Decommission Azure API for FHIR and stop the migration tool.
- Customer-managed tool: Deploy and execute the migration tool in your own environment
- Automates using existing FHIR server capabilities $export and $import
- Does continuous copies: continuously migrates new data until you stop the tool, giving time to to test your new Azure Health Data Services FHIR server, and flexibility to cutover when you want
- Migration tool copies data from your source Azure API for FHIR to an intermediate storage account, then imports that data into a new Azure Health Data Services FHIR server, giving you control over when to delete data from your original FHIR server.
- Monitor status using Azure Monitor
Please take note of the following limitations of the migration tool before choosing to utilize the tool:
- Since you are copying data to a new Azure Health Data Service FHIR server, you will have a new FHIR server URL and will need to manually point your applications to a new FHIR URL.
- The migration tool only copies FHIR resources. It will not copy over your FHIR server configurations, you will need to manually set those configurations again in your new FHIR server. See here for more information on setting configurations.
- After the initial migration, migration tool only incrementally copies new and edited FHIR resources. If a FHIR resource is hard-deleted from the source Azure API for FHIR server during the migration (after the initial migration), you will need to manually keep track of deletes that happen during the migration, and manually delete them from your new server post-migration.
- Review overall migration guidance here.
- Review configurations that you may want to set up in your new Azure Health Data Services FHIR Server here.
- The FHIR data migration tool user guide is available here.
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.
The migration tool is an open-source project. It is not a managed service, and it is not part of Microsoft Azure Health Data Services. You bear sole responsibility for compliance with local law and for any data you use with this open-source toolkit. Please review the information and licensing terms on this GitHub website before using the migration tool.
The migration tool GitHub is intended only for use in migrating data. It is not intended for use as a medical device or to perform any analysis or any medical function and the performance of the software for such purposes has not been established. You bear sole responsibility for any use of this software, including incorporation into any product intended for a medical purpose.
This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.
FHIR® is the registered trademark of HL7 and is used with the permission of HL7.