Skip to content

Commit a9e9b0e

Browse files
authored
Merge pull request #287892 from v-aljagtap/personal
[CSS issues] Update documentation based on CSS issues
2 parents de09949 + ba186f1 commit a9e9b0e

10 files changed

+64
-2
lines changed

articles/healthcare-apis/azure-api-for-fhir/customer-managed-key.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -146,6 +146,11 @@ New-AzResourceGroupDeployment `
146146
-location $accountLocation `
147147
-keyVaultKeyUri $keyVaultKeyUri
148148
```
149+
## Frequently asked questions
150+
151+
**Is the 'cosmosdb_key_vault_key_versionless_id' used in the FHIR API designed to connect to FHIR service managed Cosmos DB?**
152+
153+
Yes, when you are enabling customer-managed keys on FHIR APIs, selecting 'cosmosdb_key_vault_key_versionless_id' connects to FHIR service managed Cosmos DB.
149154

150155
## Next steps
151156

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -223,3 +223,8 @@ sections:
223223
Is there a way to encrypt my data using my personal key and not a default key?
224224
answer: |
225225
Yes, Azure API for FHIR allows configuring customer-managed keys, leveraging support from Azure Cosmos DB. For more information about encrypting your data with a personal key, see [Configure customer-managed keys at REST](customer-managed-key.md).
226+
227+
- question: |
228+
What should I do if I am unable to delete a FHIR Resource due to its provisioning state?
229+
answer: |
230+
Check if disaster recovery is enabled for the FHIR resource. If it is, disable the disaster recovery feature.

articles/healthcare-apis/azure-api-for-fhir/tutorial-web-app-test-postman.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,11 +94,16 @@ If you use the GET command to retrieve a patient again, you'll see James Tiberio
9494
9595
## Troubleshooting access issues
9696

97+
**Receiving a 403 error while trying to access the Patient resource from Postman.**
98+
99+
Check if the FHIR Contributor role is assigned; if it is not, add the FHIR Contributor role to Azure Health Data Services. [Configure Azure RBAC roles for AHDS](configure-azure-rbac.md)
100+
97101
If you ran into issues during any of these steps, review the documents we have put together on Microsoft Entra ID and the Azure API for FHIR.
98102

99103
* [Microsoft Entra ID and Azure API for FHIR](azure-active-directory-identity-configuration.md) - This document outlines some of the basic principles of Microsoft Entra ID and how it interacts with the Azure API for FHIR.
100104
* [Access token validation](azure-api-fhir-access-token-validation.md) - This how-to guide gives more specific details on access token validation and steps to take to resolve access issues.
101105

106+
102107
## Next Steps
103108

104109
Now that you can successfully connect to your client application, you’re ready to write your web application.

articles/healthcare-apis/fhir/convert-data-troubleshoot.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,10 @@ Default template implementations for many common scenarios can be found on the [
4141
## Debugging and testing
4242
In addition to testing templates on an instance of the service, a [Visual Studio Code extension](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-health-fhir-converter) is available. The extension can be used to modify templates and test them with sample data payloads. There are also several existing test scenarios in the [FHIR Converter GitHub repository](https://github.com/microsoft/FHIR-Converter/tree/main/src/Microsoft.Health.Fhir.Liquid.Converter.FunctionalTests) that can be used as a reference.
4343

44+
## Troubleshooting Azure Container Registry
45+
46+
When using Azure Container Registry (ACR) for custom template storage, if you encounter a "Failed to get access token for Azure Container Registry" error when reading templates, check to make sure that the correct role assignments are configured for the managed identity. [Configure settings for $convert-data](convert-data-configuration.md)
47+
4448
## Next steps
4549
[Overview of $convert-data](convert-data-overview.md)
4650

articles/healthcare-apis/fhir/deploy-azure-portal.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,23 @@ The Azure portal provides a web interface with guided workflows, making it an ef
5252

5353
1. Validate the deployment. Fetch the capability statement from your new FHIR service. Fetch a capability statement by browsing to `https://<WORKSPACE-NAME>-<FHIR-SERVICE-NAME>.fhir.azurehealthcareapis.com/metadata`.
5454

55+
## Troubleshoot FHIR service deployment
56+
Below are the error messages along with recommended actions to resolve the problems during deployment.
57+
58+
**What should I do if I accidentally deployed the Azure API for FHIR into the wrong subscription, deleted it, and am now facing a deployment failure in the correct subscription with a message stating that the resource name is not available?**
59+
60+
Once a service name has been used, it cannot be reused in a different subscription, even after deletion. This restriction is in place to prevent impersonation and primarily impacts Azure API for FHIR.
61+
62+
If deployed to the wrong subscription, you can move the resource to the desired subscription instead of deleting and recreating it. [Move Azure Resources](../../azure-resource-manager/management/move-resource-group-and-subscription.md)
63+
64+
**How can I delete a service and then re-add it with the same settings?**
65+
66+
To replicate settings between FHIR instance, you can follow below steps
67+
68+
* Create standard ARM templates with the configurations.
69+
70+
* Create a service and add configuration as per requirement.
71+
5572
## Related content
5673

5774
[Access the FHIR service by using Postman](../fhir/use-postman.md)

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

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,11 @@ No. We don't have a way to change the version of an existing database. You'll ne
9191

9292
No. You can't change the URL for the FHIR service.
9393

94+
### What are the limits associated with the FHIR service in Azure Health Data Services?
95+
96+
Please refer to the "Service limits" section in
97+
[Azure FHIR service limits](fhir-features-supported.md#service-limits)
98+
9499
## FHIR Implementations and Specifications
95100

96101
### What is SMART on FHIR?
@@ -138,6 +143,12 @@ To perform a health check on a FHIR service, enter `{{fhirurl}}/health/check` in
138143

139144
If there are 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.
140145

146+
**What are the recommended methods for syncing data between the FHIR service and Dataverse?**
147+
148+
Please refer to documentation for
149+
[Dataverse healthcare APIs](/dynamics365/industry/healthcare/dataverse-healthcare-apis-overview)
150+
151+
141152
## Next steps
142153

143154
In this article, you've learned the answers to frequently asked questions about FHIR service. To see the frequently asked questions about FHIR service in Azure API for FHIR, see

articles/healthcare-apis/fhir/import-data.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -252,9 +252,12 @@ Solution: Assign the **Storage Blob Data Contributor** role to the FHIR server.
252252
The `import` operation fails and returns `500 Internal Server Error`. The response body contains diagnostic content
253253

254254
**import operation failed for reason: The database '****' has reached its size quota. Partition or delete data, drop indexes, or consult the documentation for possible resolutions.**
255+
255256
Cause: You reached the storage limit of the FHIR service.
257+
256258
Solution: Reduce the size of your data or consider Azure API for FHIR, which has a higher storage limit.
257259

260+
258261
### 423 Locked
259262

260263
**Behavior:** The `import` operation fails and returns `423 Locked`. The response body includes this content:

articles/healthcare-apis/fhir/overview-of-search.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -162,11 +162,13 @@ Currently, the FHIR service in Azure Health Data Services only supports the `nex
162162

163163
## FAQ
164164

165-
What does "partial support" mean in
166-
[R4 Unsupported Search Parameters](https://github.com/microsoft/fhir-server/blob/main/src/Microsoft.Health.Fhir.Core/Data/R4/unsupported-search-parameters.json)?
165+
### What does "partial support" mean in [R4 Unsupported Search Parameters](https://github.com/microsoft/fhir-server/blob/main/src/Microsoft.Health.Fhir.Core/Data/R4/unsupported-search-parameters.json)?
167166

168167
Some of the resource-specific search parameters cover more than one data type, and the FHIR service in Azure Health Data Services may only support that search parameter on one of those data types. For example, Condition-abatement-age and Condition-onset-age cover two different data types, Age and Range; however, the FHIR service in Azure Health Data Services supports those two search parameters on Range, but not on Age.
169168

169+
### Is the $lastn operation for Observations supported?
170+
171+
This is not supported. The alternative approach would be to use _count to restrict resources returned per page and _sort to provide results in descending order.
170172

171173
## Next steps
172174

articles/healthcare-apis/fhir/rest-api-capabilities.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -179,6 +179,15 @@ Content-Type: `application/json`
179179
}
180180
```
181181

182+
## Troubleshooting
183+
184+
**Can I delete multiple patient observations or all patient resources in a single API call?**
185+
186+
The $bulk-delete operation allows you to delete resources from the FHIR server asynchronously. You can execute the $bulk-delete operation either at the system level or for specific resource types.
187+
[Bulk-delete](fhir-bulk-delete.md)
188+
189+
190+
182191
## Related content
183192

184193
[Overview of FHIR search](overview-of-search.md)

articles/healthcare-apis/fhir/troubleshoot-identity-provider-configuration.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ Here are the error messages that occur if the FHIR service SMART identity provid
3131
| **One or more SMART application `audience` values are null, empty, or invalid.** | The `audience` string in one or more application configurations is null, empty, or malformed. | Ensure the `audience` string isn't null or empty and that the value is a string type. |
3232
| **All SMART identity provider application client ids must be unique.** | The `clientId` value in one or more application configurations is the same value as another `clientId` value. | Ensure all `clientId` values are unique (including across identity provider configurations). |
3333
| **One or more SMART application client id values are null, empty, or invalid.** | The `clientId` string in one or more application configurations is null, empty, or malformed. | Ensure the `clientId` string isn't null or empty and that the value is a string type. |
34+
| **An authorization failure with the Azure Health Data Services FHIR API using third party identity provider.** | FHIR SMART user role will cause this issue as it adds an authentication layer. | Ensure that the FHIR SMART user role is not assigned. |
3435

3536
## FHIR API request errors
3637

0 commit comments

Comments
 (0)