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
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -58,11 +58,11 @@ sections:
58
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.
59
59
60
60
- question: |
61
-
What's the difference between Microsoft FHIR Server for Azure and Azure API for FHIR?
61
+
What's the difference between the Microsoft FHIR Server for Azure and Azure API for FHIR?
62
62
answer: |
63
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.
64
64
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.
65
+
When you run the FHIR Server for Azure, you have direct access to the underlying services, but we're responsible for maintaining and updating the server and all required compliance work if you're storing PHI data.
66
66
67
67
- question: |
68
68
In which regions is Azure API for FHIR available?
@@ -74,7 +74,7 @@ sections:
74
74
answer: |
75
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
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.
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'd like to test in your own environment.
78
78
79
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.
Copy file name to clipboardExpand all lines: articles/healthcare-apis/fhir/fhir-faq.md
+50-22Lines changed: 50 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ author: caitlinv39
6
6
ms.service: healthcare-apis
7
7
ms.subservice: fhir
8
8
ms.topic: reference
9
-
ms.date: 08/03/2021
9
+
ms.date: 12/28/2021
10
10
ms.author: cavoeg
11
11
ms.custom: references_regions
12
12
---
@@ -22,66 +22,89 @@ This section covers some of the frequently asked questions about the Azure Healt
22
22
23
23
### What is FHIR?
24
24
25
-
The Fast Healthcare Interoperability Resources (FHIR - Pronounced "fire") is an interoperability standard intended to enable the exchange of healthcare data between different health systems. This standard was developed by the HL7 organization and is being adopted by healthcare organizations around the world. The most current version of FHIR available is R4 (Release 4). The FHIR service supports R4 and also supports the previous version STU3 (Standard for Trial Use 3). For more information on FHIR, visit [HL7.org](http://hl7.org/fhir/summary.html).
25
+
The Fast Healthcare Interoperability Resources (FHIR - Pronounced "fire") is an interoperability standard intended to enable the exchange of healthcare data between different health systems. This standard was developed by the HL7 organization and is being adopted by healthcare organizations around the world. The most current version of FHIR available is R4 (Release 4). The FHIR service supports R4 and the previous version STU3 (Standard for Trial Use 3). For more information on FHIR, visit [HL7.org](http://hl7.org/fhir/summary.html).
26
26
27
27
### Is the data behind the FHIR APIs stored in Azure?
28
28
29
29
Yes, the data is stored in managed databases in Azure. The FHIR service in the Azure Healthcare APIs does not provide direct access to the underlying data store.
30
30
31
+
## How can I get access to the underlying data?
32
+
33
+
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).
34
+
31
35
### What identity provider do you support?
32
36
33
-
We currently support Microsoft Azure Active Directory as the identity provider.
37
+
We support Microsoft Azure Active Directory as the identity provider.
38
+
39
+
## Can I use Azure AD B2C with the FHIR service?
40
+
41
+
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).
34
42
35
43
### What FHIR version do you support?
36
44
37
45
We support versions 4.0.0 and 3.0.1.
38
46
39
-
For details, see [Supported features](fhir-features-supported.md). Read about what has changed between FHIR versions (i.e. STU3 to R4) in the [version history for HL7 FHIR](https://hl7.org/fhir/R4/history.html).
47
+
For more information, see [Supported FHIR 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).
40
48
41
-
### What is the difference between the Azure API for FHIR and the FHIR service in the Healthcare APIs?
49
+
### What is the difference between Azure API for FHIR and the FHIR service in the Healthcare APIs?
42
50
43
51
The FHIR service is our implementation of the FHIR specification that sits in the Azure Healthcare APIs, which allows you to have a FHIR service and a DICOM service within a single workspace. The Azure API for FHIR was our initial GA product and is still available as a stand-alone product. The main feature differences are:
44
52
45
53
* The FHIR service has a limit of 4TB and is in public preview while the Azure API for FHIR supports more than 4TB and is GA.
46
54
* The FHIR service support [transaction bundles](https://www.hl7.org/fhir/http.html#transaction).
47
55
* The Azure API for FHIR has more platform features (such as private link, customer managed keys, and logging) that are not yet available in the FHIR service in the Azure Healthcare APIs. More details will follow on these features by GA.
48
56
49
-
### What's the difference between 'FHIR service in the Azure Healthcare APIs' and the open-source 'FHIR server'?
57
+
### What's the difference between the FHIR service in the Azure Healthcare APIs and the open-source FHIR server?
50
58
51
-
The FHIR service in the Azure Healthcare APIs 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.
59
+
The FHIR service in the Azure Healthcare APIs is a hosted and managed version of the open-source [Microsoft FHIR Server for Azure](https://github.com/microsoft/fhir-server). In the managed service, Microsoft provides all maintenance and updates.
52
60
53
-
When you run the FHIR Server for Azure, you have direct access to the underlying services, but are responsible for maintaining and updating the server and all required compliance work if you're storing PHI data.
61
+
When you run the FHIR Server for Azure, you have direct access to the underlying services, but we're responsible for maintaining and updating the server and all required compliance work if you're storing PHI data.
54
62
55
63
### In which regions is the FHIR service available?
56
64
57
-
We are expanding the global footprints of the Healthcare APIs continually based on customer demands. The FHIR service is currently available in 25 regions including two U.S. government regions: Australia East, Brazil South*, Canada Central, Central India*, East Asia*, East US 2, East US, Germany North**, Germany West Central, Germany North**, Japan East, Japan West*, Korea Central*, North Central US, North Europe, South Africa North, South Central US, Southeast Asia, Switzerland North, UK South, UK West, West Central US, West Europe, West US 2, USGov Virginia, USGov Arizona.
65
+
We are expanding the global footprints of the Healthcare APIs continually based on customer demands and is available in multiple geo-regions.
58
66
59
-
*denotes private preview regions; ** denotes disaster recovery region only.
67
+
### Where can I see what is releasing into the FHIR service?
60
68
61
-
For more information, please see the [support for geo-regions](https://azure.microsoft.com/global-infrastructure/services/?products=azure-api-for-fhir®ions=all).
69
+
The [release notes](../release-notes.md) page provides an overview of everything that has shipped to the managed service in the previous month.
62
70
63
-
### Where can I see what is releasing into the FHIR service?
71
+
To see what will be releasing to the managed service, you can review the [releases page](https://github.com/microsoft/fhir-server/releases) of the open-source FHIR Server. We have worked to tag items with Azure Healthcare APIs 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'd like to test in your own environment. We are evaluating how to best share additional managed service updates.
64
72
65
-
To see some of what is releasing into the FHIR service, please refer to the [release](https://github.com/microsoft/fhir-server/releases) of the open-source FHIR Server. We have worked to tag items with FHIR-Service 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 [here](https://github.com/microsoft/fhir-server/blob/master/docs/Testing-Releases.md) if you would like to test in your own environment. We are evaluating how to best share additional managed service updates.
73
+
To see what release package is currently in the managed service, you can view the capability statement for the FHIR service and under the `software.version` property. You'll see which package is deployed.
66
74
67
-
### What is SMART on FHIR?
75
+
### Where can I find what version of FHIR (R4/STU3) is running on my database?
76
+
77
+
You can find the exact FHIR version exposed in the capability statement under the `fhirVersion` property (FHIR URL/metadata).
78
+
79
+
### Can I switch my FHIR service from STU3 to R4?
68
80
69
-
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.
70
-
To learn more about SMART, visit [SMART Health IT](https://smarthealthit.org/).
81
+
No. We don't have a way to change the version of an existing database. You'll need to create a new FHIR service and reload the data. You can leverage the JSON to FHIR converter as a place to start with converting STU3 data into R4.
71
82
72
-
### Where can I find what version of FHIR is running on my database.
83
+
### Can I customize the URL for my FHIR service?
73
84
74
-
You can find the exact FHIR version exposed in the capability statement under the "fhirVersion" property (FHIR URL/metadata)
85
+
No. You can't change the URL for the FHIR service.
75
86
76
87
## FHIR Implementations and Specifications
77
88
89
+
### What is SMART on FHIR?
90
+
91
+
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, see [SMART Health IT](https://smarthealthit.org/).
92
+
93
+
### Does the FHIR service support SMART on FHIR?
94
+
95
+
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.
96
+
78
97
### Can I create a custom FHIR resource?
79
98
80
99
We do not allow custom FHIR resources. If you need a custom FHIR resource, you can build a custom resource on top of the [Basic resource](http://www.hl7.org/fhir/basic.html) with extensions.
81
100
82
101
### Are [extensions](https://www.hl7.org/fhir/extensibility.html) supported on the FHIR service?
83
102
84
-
We allow you to load any valid FHIR JSON data into the server. If you want to store the structure definition that defines the extension, you could save this as a structure definition resource. To search on extensions, you'll need to [define your own search parameters](how-to-do-custom-search.md).
103
+
We allow you to load any valid FHIR JSON data into the server. If you want to store the structure definition that defines the extension, you can save this as a structure definition resource. To search on extensions, you'll need to [define your own search parameters](how-to-do-custom-search.md).
104
+
105
+
### How do I see the FHIR service in XML?
106
+
107
+
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`.
85
108
86
109
### What is the limit on _count?
87
110
@@ -95,12 +118,17 @@ We currently support posting [batch bundles](https://www.hl7.org/fhir/valueset-b
95
118
96
119
We support the [$patient-everything operation](patient-everything.md) which will get you all data related to a single patient.
97
120
121
+
### What is the default sort when searching for resources in the FHIR service?
122
+
123
+
We support sorting by string and dateTime fields in the FHIR service. For more information about other supported search parameters, see [Overview of FHIR search](overview-of-search.md).
124
+
125
+
### Does the FHIR service support any terminology operations?
126
+
127
+
No, Azure API for FHIR doesn't support terminology operations today.
128
+
98
129
## Using the FHIR service
99
130
100
131
### Where can I see some examples of using the FHIR service within a workflow?
101
132
102
133
We have a collection of reference architectures available on the [Health Architecture GitHub page](https://github.com/microsoft/health-architectures).
103
134
104
-
### Where can I see an example of connecting a web application to FHIR service?
105
-
106
-
We have a [Health Architecture GitHub page](https://aka.ms/health-architectures) that contains example applications and scenarios. It illustrates how to connect a web application to FHIR service.
0 commit comments