Skip to content

Commit d886065

Browse files
final fixes
1 parent 954a874 commit d886065

File tree

5 files changed

+61
-56
lines changed

5 files changed

+61
-56
lines changed

articles/healthcare-apis/azure-api-for-fhir/index.yml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ summary: Azure API for FHIR is a managed, standards-based, compliant API for cli
55

66
metadata:
77
title: Azure API for FHIR Documentation - tutorials, how-to guides
8-
description: Azure API for FHIR is a managed, standards-based, compliant API for clinical health data that enables solutions for actionable analytics and machine learning.
8+
description: This service will be retired on September 30, 2026.
99
services: healthcare-apis
1010
ms.service: healthcare-apis
1111
ms.subservice: fhir
@@ -29,7 +29,10 @@ landingContent:
2929
links:
3030
- text: Migrate to Azure Health Data Services
3131
url: ../fhir/migration-strategies.md
32-
32+
- linkListType: learn
33+
links:
34+
- text: Migration FAQ
35+
url: ../fhir/migration-faq.md
3336
- title: Access Azure API for FHIR
3437
linkLists:
3538
- linkListType: concept

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

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,11 @@ ms.custom: references_regions
1313

1414
# Frequently asked questions about FHIR service
1515

16+
[!INCLUDE [retirement banner](../includes/healthcare-apis-azure-api-fhir-retirement.md)]
17+
1618
This section covers some of the frequently asked questions about the Azure Health Data Services FHIR service (hereby called FHIR service).
1719

18-
## FHIR service: The Basics
20+
## FHIR service: The basics
1921

2022
### What is FHIR?
2123

@@ -25,15 +27,15 @@ The Fast Healthcare Interoperability Resources (FHIR - Pronounced "fire") is an
2527

2628
Yes, the data is stored in managed databases in Azure. The FHIR service in Azure Health Data Services doesn't provide direct access to the underlying data store.
2729

28-
## How can I get access to the underlying data?
30+
### How can I get access to the underlying data?
2931

3032
In the managed service, you can't access the underlying data. This is to ensure that the FHIR service offers the privacy and compliance certifications needed for healthcare data. If you need access to the underlying data, you can use the [open-source FHIR server](https://github.com/microsoft/fhir-server).
3133

3234
### What identity provider do you support?
3335

3436
We support Microsoft Azure Active Directory as the identity provider.
3537

36-
## Can I use Azure AD B2C with the FHIR service?
38+
### Can I use Azure AD B2C with the FHIR service?
3739

3840
No, we don't support B2C in the FHIR service. If you need more granular access controls, we recommend looking at the [open-source FHIR proxy](https://github.com/microsoft/fhir-proxy).
3941

@@ -45,14 +47,12 @@ For more information, see [Supported FHIR features](fhir-features-supported.md).
4547

4648
### What is the difference between Azure API for FHIR and the FHIR service in the Azure Health Data Services?
4749

48-
FHIR service is our implementation of the FHIR specification that sits in the Azure Health Data Services, which allows you to have a FHIR service and a DICOM service within a single workspace. Azure API for FHIR was our initial GA product and is still available as a stand-alone product. The main feature differences are:
50+
Azure API for FHIR was our initial generally available product and is being retired as of September 30, 2026. The Azure Health Data Services FHIR service supports additional capabilities such as:
51+
52+
- [Transaction bundles](https://www.hl7.org/fhir/http.html#transaction).
53+
- [Incremental Import](configure-import-data.md)
54+
- [Autoscaling](fhir-service-autoscale.md) enabled by default
4955

50-
* FHIR service has a limit of 4 TB, and Azure API for FHIR supports more than 4 TB.
51-
* FHIR service support additional capabilities as
52-
** [Transaction bundles](https://www.hl7.org/fhir/http.html#transaction).
53-
** [Incremental Import](configure-import-data.md).
54-
** [Autoscaling](fhir-service-autoscale.md) is enabled by default.
55-
* Azure API for FHIR has more platform features (such as customer managed keys, and cross region DR) that aren't yet available in FHIR service in Azure Health Data Services.
5656

5757
### What's the difference between the FHIR service in Azure Health Data Services and the open-source FHIR server?
5858

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

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,10 @@ ms.date: 9/27/2023
1616

1717
Azure API for FHIR will be retired on September 30, 2026.
1818

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+
1923
## Why is Microsoft retiring Azure API for FHIR?
2024

2125
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. See below for detailed benefits of migrating to Azure Health Data Services FHIR service. With this new experience, we’re retiring Azure API for FHIR.
@@ -31,28 +35,20 @@ AHDS FHIR service offers a rich set of capabilities such as:
3135
- Events to trigger new workflows when FHIR resources are created, updated or deleted
3236
- Connectors to Azure Synapse Analytics, Power BI and Azure Machine Learning for enhanced analytics
3337

34-
## SMART on FHIR Proxy is planned for deprecation in Gen2. When we migrate from Gen1, what are the steps for enabling SMART on FHIR in Gen2?
38+
## What are the steps to enable SMART on FHIR in Azure Health Data Service FHIR service?
3539

36-
SMART on FHIR proxy will be 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 in accessing the FHIR service.
40+
SMART on FHIR proxy will be 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.
3741

3842
SMART on FHIR (Enhanced) provides added capabilities than SMART on FHIR proxy and can be considered to meet requirements with SMART on FHIR Implementation Guide (v 1.0.0) and §170.315(g)(10) Standardized API for patient and population services criterion.
3943

4044
## What will happen after the service is retired on September 30, 2026?
4145

42-
After September 20, 2026 customers won't be able to:
46+
After September 30, 2026 customers won't be able to:
4347

4448
- Create or manage Azure API for FHIR accounts
4549
- Access the data through the Azure portal or APIs/SDKs/client tools
4650
- Receive service updates to Azure API for FHIR or APIs/SDKs/client tools
4751
- Access customer support (phone, email, web)
4852
- Where can customers go to learn more about migrating to Azure Health Data Services FHIR service?
4953

50-
Start with \<Link to Azure Docs migration guidance \> to learn more about Azure API for FHIR to Azure Health Data Services FHIR service migration. Please be advised that the migration from Azure API for FHIR to Azure Health Data Services FHIR service involves data migration as well updating the applications to use Azure Health Data Services FHIR service. You can find more documentation on the step-by-step approach to migrating your data and applications in this migration tool \<Link to github repo\>.
51-
52-
## Where can customers go to get answers to their questions?
53-
54-
Check out these resources if you need further assistance:
55-
56-
- Get answers from community experts in Microsoft Q&A \<Link to Microsoft Q&A Page\>
57-
58-
- If you have a support plan and require technical support, [contact us](https://portal.azure.com/#blade/Microsoft_Azure_Support/HelpAndSupportBlade/newsupportrequest).
54+
Start with [migration strategies](migration-strategies.md) to learn more about Azure API for FHIR to Azure Health Data Services FHIR service migration. Note that the migration from Azure API for FHIR to Azure Health Data Services FHIR service involves data migration as well updating the applications to use Azure Health Data Services FHIR service. You can 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: 37 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -67,36 +67,42 @@ First, create a migration plan. We recommend the migration patterns described in
6767
| 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](https://learn.microsoft.com/azure/healthcare-apis/azure-api-for-fhir/export-data) your data on Azure API for FHIR, and then [\$import](https://learn.microsoft.com/azure/healthcare-apis/fhir/configure-import-data) 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, as well as a script to help automate creating the \$import payload. Or, create your own tool to migrate the data using \$export and \$import. |
6868
| 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.
6969

70-
## Use the OSS migration tool
71-
72-
If you decide to use the OSS migration tool, review and understand the migration tool’s capabilities and limitations.
73-
- Prepare Azure API for FHIR server
74-
- Identify data to migrate.
75-
- Take this opportunity to clean up data or FHIR servers that you no longer use.
76-
- Decide if you want to migrate historical versions or not. See below “Deploy a new Azure Health Data Services FHIR Service server” for more information.
77-
- If you’re planning to use the migration tool:
78-
- See “Azure API for FHIR preparation” (link to github below) for additional things to note.
79-
- Deploy a new Azure Health Data Services FHIR Service server
80-
- Deploy an Azure Health Data Services Workspace first
81-
- Then deploy a Azure Health Data Services FHIR Service server ([Deploy a FHIR service within Azure Health Data Services \| Microsoft Learn)](https://learn.microsoft.com/azure/healthcare-apis/fhir/fhir-portal-quickstart)
82-
- Configure your new Azure Health Data Services FHIR Service server. If you’d like to use the same configurations that you had in Azure API for FHIR for your new Azure Health Data Services FHIR Service server, see a recommended list of what to check for here (link to Github section [Migration Tool Documentation.docx](https://microsoft.sharepoint.com/:w:/t/msh/Eb7WohSv_6JNlG1xAI8TyvoBbAPfhxnPzr4wv9py1InEww?e=QeSbo3&nav=eyJoIjoiMTUwODIzNzMifQ)) Configure settings that are needed “pre-migration”.
83-
84-
## 3) Migrate data
85-
86-
- Choose the migration pattern that works best for your organization.
87-
- If you are using OSS migration tools, please follow instructions on Github.
88-
-
89-
## 4) Migrate applications and reconfigure settings
90-
91-
- Migrate applications that were pointing to the old FHIR server.
92-
- Change the endpoints on your applications so that they point to the new FHIR server’s URL.
93-
- (insert link on how to find the new server’s URL)
94-
- Set up permissions again for these apps.
95-
- <https://learn.microsoft.com/azure/storage/blobs/assign-azure-role-data-access>
96-
- Reconfigure any remaining settings in the new Azure Health Data Services FHIR Service server “post-migration” (Insert link below)
97-
- If you’d like to doublecheck 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](https://learn.microsoft.com/azure/healthcare-apis/fhir/use-postman#get-capability-statement) to compare and contrast the two servers.
98-
- Set up any jobs that were previously running in your old Azure API for FHIR server (for example, \$export jobs)
99-
100-
## 5) Cut over to Azure Health Data Services FHIR Services
70+
### OSS migration tool considerations
71+
72+
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).
73+
#### Prepare Azure API for FHIR server
74+
Identify data to migrate.
75+
- Take this opportunity to clean up data or FHIR servers that you no longer use.
76+
77+
- Decide if you want to migrate historical versions or not. See below “Deploy a new Azure Health Data Services FHIR Service server” for more information.
78+
79+
- If you’re planning to use the migration tool see “Azure API for FHIR preparation” (link to github below) for additional things to note.
80+
81+
Deploy a new Azure Health Data Services FHIR Service server.
82+
- First, deploy an Azure Health Data Services workspace.
83+
84+
- Then deploy a Azure Health Data Services FHIR Service server ([Deploy a FHIR service within Azure Health Data Services \| Microsoft Learn)](https://learn.microsoft.com/azure/healthcare-apis/fhir/fhir-portal-quickstart)
85+
86+
- Configure your new Azure Health Data Services FHIR Service server. If you’d like to use the same configurations that you had in Azure API for FHIR for your new Azure Health Data Services FHIR Service server, see a recommended list of what to check for in the [migration T\tool documentation](https://microsoft.sharepoint.com/:w:/t/msh/Eb7WohSv_6JNlG1xAI8TyvoBbAPfhxnPzr4wv9py1InEww?e=QeSbo3&nav=eyJoIjoiMTUwODIzNzMifQ)) Configure settings that are needed before you migrate.
87+
88+
## Step 3: Migrate data
89+
90+
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).
91+
92+
## Step 4: Migrate applications and reconfigure settings
93+
94+
Migrate applications that were pointing to the old FHIR server.
95+
96+
- Change the endpoints on your applications so that they point to the new FHIR server’s URL.
97+
98+
- Set up permissions again for [these apps](https://learn.microsoft.com/azure/storage/blobs/assign-azure-role-data-access).
99+
100+
- Reconfigure any remaining settings in the new Azure Health Data Services FHIR Service server after migration.
101+
102+
- If you’d like to doublecheck 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](https://learn.microsoft.com/azure/healthcare-apis/fhir/use-postman#get-capability-statement) to compare and contrast the two servers.
103+
104+
- Set up any jobs that were previously running in your old Azure API for FHIR server (for example, \$export jobs)
105+
106+
## Step 5: Cut over to Azure Health Data Services FHIR Services
101107

102108
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 you used it), delete data from your Azure API for FHIR server, and decommission your Azure API for FHIR account.

articles/healthcare-apis/includes/healthcare-apis-azure-api-fhir-retirement.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ ms.author: jasteppe
88
---
99

1010
> [!IMPORTANT]
11-
> **Azure API for FHIR will be retired on September 30, 2026.** Follow the [migration guidance](../fhir/migration-strategies.md) to transition to Azure Health Data Services FHIR service by that date. Due to the transition of Azure API for FHIR to Azure Health Data Services, new deployments won't be allowed beginning April 1, 2025.
11+
> **Azure API for FHIR will be retired on September 30, 2026.** Follow the [migration strategies](../fhir/migration-strategies.md) to transition to Azure Health Data Services FHIR service by that date. Due to the transition of Azure API for FHIR to Azure Health Data Services, new deployments won't be allowed beginning April 1, 2025.
1212
1313
[Azure Health Data Services FHIR service](../healthcare-apis-overview.md) is the evolved version of Azure API for FHIR that enables customers to manage [FHIR](../fhir/overview.md), DICOM, and MedTech services with integrations into other Azure services.
1414

0 commit comments

Comments
 (0)