You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/healthcare-apis/azure-api-for-fhir/fhir-faq.yml
+24-22Lines changed: 24 additions & 22 deletions
Original file line number
Diff line number
Diff line change
@@ -28,7 +28,7 @@ sections:
28
28
- question: |
29
29
How can I get access to the underlying data?
30
30
answer: |
31
-
In the managed service, you can't access the underlying data. This is to ensure that the Azure API for FHIR 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.
31
+
In the managed service, you can't access the underlying data. This is to ensure that the Azure API for FHIR 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).
32
32
33
33
- question: |
34
34
What identity provider do you support?
@@ -38,7 +38,7 @@ sections:
38
38
- question: |
39
39
Can I use Azure AD B2C with the Azure API for FHIR?
40
40
answer: |
41
-
No, we don't support B2C in the Azure API for FHIR. If you need more granular access controls, we recommend looking at the open-source FHIR proxy.
41
+
No, we don't support B2C in the Azure API for FHIR. If you need more granular access controls, we recommend looking at the [open-source FHIR proxy](https://github.com/microsoft/fhir-proxy).
42
42
43
43
- question: |
44
44
What is the Recovery Point Objective (RPO) for the Azure API for FHIR?
@@ -48,21 +48,19 @@ sections:
48
48
- question: |
49
49
What FHIR version do you support?
50
50
answer: |
51
-
We support versions 4.0.0 and 3.0.1.
52
-
53
-
For more details, see the [FHIR supported features](fhir-features-supported.md). You can also read about what has changed between FHIR versions (that's STU3 to R4) in the [version history for HL7 FHIR](https://hl7.org/fhir/R4/history.html).
51
+
We support versions 4.0.0 and 3.0.1. For more information, see the [FHIR supported features](fhir-features-supported.md). You can also read about what has changed between FHIR versions (STU3 to R4) in the [version history for HL7 FHIR](https://hl7.org/fhir/R4/history.html).
54
52
55
53
Azure IoT Connector for FHIR (preview) currently supports only FHIR version R4 and is visible on R4 instances of Azure API for FHIR.
56
54
57
55
- question: |
58
-
What's the difference between the Azure Healthcare APIs and the Azure API for FHIR?
56
+
What's the difference between Azure Healthcare APIs and Azure API for FHIR?
59
57
answer: |
60
-
The Azure API for FHIR is a generally available managed FHIR service. The Azure Healthcare APIs is in public preview and allows you to deploy a FHIR service and a DICOM service in the same workspace. The Azure Healthcare APIs overview gives more details.
58
+
Azure API for FHIR is a generally available managed FHIR service. Azure Healthcare APIs is in public preview and allows you to deploy a FHIR service and a DICOM service in the same workspace. The Azure Healthcare APIs overview gives more details.
61
59
62
60
- question: |
63
-
What's the difference between 'Microsoft FHIR Server for Azure' and the 'Azure API for FHIR'?
61
+
What's the difference between Microsoft FHIR Server for Azure and Azure API for FHIR?
64
62
answer: |
65
-
The Azure API for FHIR is a hosted and managed version of the open-source Microsoft FHIR Server for Azure. In the managed service, Microsoft provides all maintenance and updates.
63
+
Azure API for FHIR is a hosted and managed version of the open-source Microsoft FHIR Server for Azure. In the managed service, Microsoft provides all maintenance and updates.
66
64
67
65
When you run the FHIR Server for Azure, you have direct access to the underlying services, but they're responsible for maintaining and updating the server and all required compliance work if you're storing PHI data.
68
66
@@ -72,9 +70,13 @@ sections:
72
70
We have general availability for both public and government in [multiple geo-regions](https://azure.microsoft.com/global-infrastructure/services/?products=azure-api-for-fhir®ions=non-regional,us-east,us-east-2,us-central,us-north-central,us-south-central,us-west-central,us-west,us-west-2,canada-east,canada-central,usgov-non-regional,us-dod-central,us-dod-east,usgov-arizona,usgov-texas,usgov-virginia). For information about government cloud services at Microsoft, see [Azure services by FedRAMP](../../azure-government/compliance/azure-services-in-fedramp-auditscope.md).
73
71
74
72
- question: |
75
-
Where can I see what is releasing into the Azure API for FHIR?
73
+
Where can I see what is releasing in Azure API for FHIR?
76
74
answer: |
77
-
The [release notes](https://docs.microsoft.com/azure/healthcare-apis/azure-api-for-fhir/release-notes) page provides an overview of everything that has shipped to the managed service in the previous month. For more information about what's releasing into the Azure API for FHIR, see [releases](https://github.com/microsoft/fhir-server/releases) of the open-source FHIR Server. We have worked to tag items with Azure-API-for-FHIR if they will release to the managed service and are usually available two weeks after they are on the release page in open-source. We have also included instructions on [how to test the build](https://github.com/microsoft/fhir-server/blob/master/docs/Testing-Releases.md) if you need to test in your own environment. To see what release package is currently in the managed service, you can view the capability statement for the Azure API for FHIR under the `software.version` property. You'll see which package is deployed.
75
+
The [release notes](https://docs.microsoft.com/azure/healthcare-apis/azure-api-for-fhir/release-notes) page provides an overview of everything that has shipped to the managed service in the previous month.
76
+
77
+
For more information about what's releasing in Azure API for FHIR, see [releases](https://github.com/microsoft/fhir-server/releases) of the open-source FHIR Server. We have worked to tag items with Azure-API-for-FHIR if they will release to the managed service and are usually available two weeks after they are on the release page in open-source. We have also included instructions on [how to test the build](https://github.com/microsoft/fhir-server/blob/master/docs/Testing-Releases.md) if you need to test in your own environment.
78
+
79
+
To see what release package is currently in the managed service, you can view the capability statement for the Azure API for FHIR under the `software.version` property. You'll see which package is deployed.
78
80
79
81
- question: |
80
82
Where can I find what version of FHIR (that is R4/STU3) is running on my database?
@@ -84,7 +86,7 @@ sections:
84
86
- question: |
85
87
Can I switch my Azure API for FHIR from STU3 to R4?
86
88
answer: |
87
-
No. We do not have a way to change the version of an existing database. You'll need to create a new Azure API for FHIR and reload the data. You can leverage the JSON to FHIR converter as a place to start with converting STU3 data into R4.
89
+
No. We do not have a way to change the version of an existing database. You'll need to create a new Azure API for FHIR and reload the data. You can leverage the [JSON to FHIR converter](https://github.com/microsoft/FHIR-Converter) as a place to start with converting STU3 data into R4.
88
90
89
91
- question: |
90
92
Can I customize the URL for my Azure API for FHIR?
@@ -99,7 +101,7 @@ sections:
99
101
SMART (Substitutable Medical Applications and Reusable Technology) on FHIR is a set of open specifications to integrate partner applications with FHIR Servers and other Health IT systems, such as Electronic Health Records and Health Information Exchanges. By creating a SMART on FHIR application, you can ensure that your application can be accessed and leveraged by a plethora of different systems. For more information about SMART, visit the [SMART Health IT](https://smarthealthit.org/) website.
100
102
101
103
- question: |
102
-
Does the Azure API for FHIR support SMART on FHIR?
104
+
Does Azure API for FHIR support SMART on FHIR?
103
105
answer: |
104
106
We have a basic SMART on FHIR proxy as part of the managed service. If this doesn't meet your needs, you can use the open-source FHIR proxy for more advanced SMART scenarios.
105
107
@@ -119,7 +121,7 @@ sections:
119
121
Your resource must be just under 2 MB. This is a limitation from the underlying datastore, and we can't increase this value.
120
122
121
123
- question: |
122
-
How do I see the Azure API for FHIR in XML?
124
+
How do I see Azure API for FHIR in XML?
123
125
answer: |
124
126
In the managed service, we only support JSON. The open-source FHIR server supports JSON and XML. To view the XML version in open-source, use `_format= application/fhir+xml`.
125
127
@@ -134,14 +136,14 @@ sections:
134
136
For Group Export, we only export the included references from the group and not all the characteristics of the [group resource](https://www.hl7.org/fhir/group.html).
135
137
136
138
- question: |
137
-
Can I post a bundle to the Azure API for FHIR?
139
+
Can I post a bundle to Azure API for FHIR?
138
140
answer: |
139
-
We currently support posting [batch bundles](https://www.hl7.org/fhir/valueset-bundle-type.html), but we don't support posting transaction bundles in the Azure API for FHIR. You can use the FHIR service in the Azure Healthcare APIs if you need transaction bundle support.
141
+
We currently support posting [batch bundles](https://www.hl7.org/fhir/valueset-bundle-type.html), but we don't support posting transaction bundles in Azure API for FHIR. You can use the FHIR service in the Azure Healthcare APIs if you need transaction bundle support.
140
142
141
143
- question: |
142
-
How can I get all resources for a single patient in the Azure API for FHIR?
144
+
How can I get all resources for a single patient in Azure API for FHIR?
143
145
answer: |
144
-
You can use the [Patient-$everything operation](patient-everything.md), or you can use a [compartment search](https://www.hl7.org/fhir/compartmentdefinition.html) in the Azure API for FHIR. This allows you to get all the resources related to a specific patient. Note that the patient compartment includes all the resources related to the patient but not the patient itself, so you'll need to also search to get the patient if you need the patient resource in your results.
146
+
You can use the [Patient-$everything operation](patient-everything.md), or you can use a [compartment search](https://www.hl7.org/fhir/compartmentdefinition.html) in Azure API for FHIR. This allows you to get all the resources related to a specific patient. Note that the patient compartment includes all the resources related to the patient but not the patient itself, so you'll need to also search to get the patient if you need the patient resource in your results.
145
147
146
148
- question: |
147
149
What is the default sort when searching for resources in Azure API for FHIR?
@@ -154,9 +156,9 @@ sections:
154
156
Yes, we do have support for patient-$everything. For more information, see the [Patient-$Everything how-to guide](patient-everything.md).
155
157
156
158
- question: |
157
-
Does the Azure API for FHIR support any terminology operations?
159
+
Does Azure API for FHIR support any terminology operations?
158
160
answer: |
159
-
No, the Azure API for FHIR doesn't support terminology operations today.
161
+
No, Azure API for FHIR doesn't support terminology operations today.
160
162
161
163
- question: |
162
164
How does $export work?
@@ -166,7 +168,7 @@ sections:
166
168
- question: |
167
169
Is there an out of the box solution for de-identifying EHR data?
168
170
answer: |
169
-
We have an open-source tool to de-identify FHIR data. The same technology is also integrated to the Azure API for FHIR in the form of (de-identified) export.
171
+
We have an open-source tool to de-identify FHIR data. The same technology is also integrated to Azure API for FHIR in the form of [de-identified](de-identified-export.md) export.
170
172
171
173
- question: |
172
174
Is de-identified export available at Patient and Group level as well?
@@ -183,7 +185,7 @@ sections:
183
185
- question: |
184
186
I'm getting 429s when loading and updating data. How can I resolve this?
185
187
answer: |
186
-
To resolve this you can increase your throughput or switch over to autoscaling to ensure that you have enough compute to process the requests. If you're still having issues, please open a support ticket.
188
+
To resolve this you can increase your [throughput](https://docs.microsoft.com/azure/healthcare-apis/azure-api-for-fhir/configure-database.md#update-throughput) or switch over to [autoscaling](autoscale-azure-api-fhir.md) to ensure that you have enough compute to process the requests. If you're still having issues, please open a support ticket.
187
189
188
190
- question: |
189
191
How do I lower my RUs, and I'm unable to and the RUs are higher than I set them?
0 commit comments