Skip to content

Commit baf6558

Browse files
v-dirichardsv-dirichards
authored
Merge pull request #252739 from shellyhaverkamp/smh-migration-articles
new migration articles
2 parents 23afa07 + dfe7231 commit baf6558

File tree

4 files changed

+33
-23
lines changed

4 files changed

+33
-23
lines changed

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -140,8 +140,9 @@ There are two basic Delete types supported within the FHIR service. These are [D
140140

141141
### Can I perform health checks on FHIR service?
142142

143-
To perform health check on FHIR service , enter `{{fhirurl}}/health/check` in the GET request. You should be able to see Status of FHIR service. HTTP Status code response with 200 and OverallStatus as "Healthy" in response, means your health check is successful.
144-
In case of errors, you will receive error response with HTTP status code 404 (Not Found) or status code 500 (Internal Server Error), and detailed information in response body in some scenarios.
143+
To perform a health check on a FHIR service, enter `{{fhirurl}}/health/check` in the GET request. You should be able to see status of FHIR service. HTTP Status code response with 200 and OverallStatus as **Healthy** in response means your health check is successful.
144+
145+
In case of errors, you may receive an error response with HTTP status code 404 (Not Found) or status code 500 (Internal Server Error), and detailed information in the response body.
145146

146147
## Next steps
147148

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

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Migration FAQ
2+
title: FAQ about migrations from Azure API for FHIR
33
description: Find answers to your questions about migrating FHIR data from Azure API for FHIR to the Azure Health Data Services FHIR service.
44
services: healthcare-apis
55
ms.service: healthcare-apis
@@ -51,4 +51,11 @@ After September 30, 2026 customers won't be able to:
5151
- Access customer support (phone, email, web)
5252
- Where can customers go to learn more about migrating to Azure Health Data Services FHIR service?
5353

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).
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 the [migration tool](https://go.microsoft.com/fwlink/?linkid=2247964).
55+
56+
## Where can customers go to get answers to their questions?
57+
58+
Check out these resources if you need further assistance:
59+
60+
- Get answers from community experts in [Microsoft Q&A](https://go.microsoft.com/fwlink/?linkid=2248420).
61+
- If you have a support plan and require technical support, [contact us](https://ms.portal.azure.com/#view/Microsoft_Azure_Support/HelpAndSupportBlade/~/overview).

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

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Migration strategies
2+
title: Migration strategies for moving from Azure API for FHIR
33
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.
44
services: healthcare-apis
55
ms.service: healthcare-apis
@@ -34,14 +34,14 @@ To migrate your data, follow these steps:
3434
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.
3535

3636
|**Capabilities** |**Azure API for FHIR** |**Azure Health Data Services** |
37-
|-------|-------|-------|
38-
| **Settings** | Supported: Local RBAC • SMART on FHIR Proxy | Planned deprecation - Local RBAC (9/6/23) - SMART on FHIR Proxy (9/21/26) | | |
37+
|---|---|---|
38+
| **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) | | |
3939
| **Data storage Volume** | More than 4 TB | Current support is 4 TB. Reach out to CSS team if you need more than 4 TB. | | |
4040
| **Data ingress** | Tools available in OSS | $import operation | | |
4141
| **Autoscaling** | Supported on request and incurs charge | Enabled by default at no extra charge | | |
42-
| **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+
| **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 | | |
4343
| **Events** | Not Supported | Supported | | |
44-
| **Infrastructure** | Supported: - Customer managed keys - AZ support and PITR - Cross region DR | Supported - Data recovery - Upcoming: AZ support for customer managed keys | | |
44+
| **Infrastructure** | Supported: - <br> • Customer managed keys <br> • AZ support and PITR <br> • Cross region DR | Supported - Data recovery <br> Upcoming: AZ support for customer managed keys | | |
4545

4646
### Things to consider that may affect your architecture
4747

@@ -61,30 +61,32 @@ If you want to migrate existing IoT connector device FHIR data from your Azure A
6161

6262
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.
6363

64-
| Migration Pattern | Details | How? |
65-
|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
66-
| 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. |
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. 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.
64+
| Migration Pattern | Details | How? |
65+
|---|---|---|
66+
| Lift and shift | The simplest pattern. Ideal if your data pipelines 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://go.microsoft.com/fwlink/?linkid=2247964) 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://go.microsoft.com/fwlink/?linkid=2248131) to help with this migration pattern. <br> • Or create your own tool to migrate the data incrementally.|
6868

6969
### OSS migration tool considerations
7070

71-
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+
If you decide to use the OSS migration tool, review and understand the migration tool’s [capabilities and limitations](https://go.microsoft.com/fwlink/?linkid=2248324).
72+
7273
#### Prepare Azure API for FHIR server
74+
7375
Identify data to migrate.
7476
- Take this opportunity to clean up data or FHIR servers that you no longer use.
7577

7678
- Decide if you want to migrate historical versions or not.
7779

7880
Deploy a new Azure Health Data Services FHIR Service server.
7981
- First, deploy an Azure Health Data Services workspace.
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)
8084

81-
- Then deploy an Azure Health Data Services FHIR Service server ([Deploy a FHIR service within Azure Health Data Services](fhir-portal-quickstart.md)
82-
83-
- 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.
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://go.microsoft.com/fwlink/?linkid=2248324). Configure the settings before you migrate.
8486

8587
## Step 3: Migrate data
8688

87-
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).
89+
Choose the migration pattern that works best for your organization. If you're using OSS migration tools, follow the instructions on [GitHub](https://go.microsoft.com/fwlink/?linkid=2248130).
8890

8991
## Step 4: Migrate applications and reconfigure settings
9092

@@ -103,6 +105,3 @@ Migrate applications that were pointing to the old FHIR server.
103105
## Step 5: Cut over to Azure Health Data Services FHIR services
104106

105107
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.
106-
107-
108-
[def]: https://learn.microsoft.com/azure/healthcare-apis/events/events-overview

‎articles/healthcare-apis/index.yml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ metadata:
1111
ms.topic: hub-page # Required
1212
author: msjasteppe #Required; your GitHub user alias, with correct capitalization.
1313
ms.author: jasteppe #Required; microsoft alias of author; optional team alias.
14-
ms.date: 09/11/2023 #Required; mm/dd/yyyy format.
14+
ms.date: 09/27/2023 #Required; mm/dd/yyyy format.
1515

1616
highlightedContent:
1717
items:
@@ -24,6 +24,9 @@ highlightedContent:
2424
- title: Get an access token
2525
itemType: how-to-guide
2626
url: ./get-access-token.md
27+
- title: Migrate your data from Azure API for FHIR
28+
itemType: how-to-guide
29+
url: ./fhir/migration-strategies.md
2730
- title: Azure Health Data Services
2831
itemType: training
2932
url: https://learn.microsoft.com/training/browse/?term=iot&terms=health%20data%20services
@@ -139,5 +142,5 @@ additionalContent:
139142
items:
140143
# Card
141144
- title: Azure API for FHIR
142-
summary: Scalable, secure, standards-based service for FHIR data
145+
summary: This service is being retired as of September 30, 2026
143146
url: ./azure-api-for-fhir/overview.md

0 commit comments

Comments
 (0)