Skip to content

Commit 6f8a3bc

Browse files
authored
Merge pull request #218275 from EXPEkesheth/patch-15
Update smart-on-fhir.md
2 parents 559f081 + b235fc1 commit 6f8a3bc

File tree

1 file changed

+39
-23
lines changed

1 file changed

+39
-23
lines changed

articles/healthcare-apis/fhir/smart-on-fhir.md

Lines changed: 39 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -12,29 +12,39 @@ ms.date: 11/10/2022
1212

1313
# SMART on FHIR
1414

15-
[SMART on FHIR](https://docs.smarthealthit.org/) is a set of open specifications to integrate partner applications with FHIR servers and electronic medical records systems that have Fast Healthcare Interoperability Resources (FHIR®) interfaces. One of the main purposes of the specifications is to describe how an application should discover authentication endpoints for an FHIR server and start an authentication sequence.
15+
Substitutable Medical Applications and Reusable Technologies [SMART on FHIR](https://docs.smarthealthit.org/) is a healthcare standard through which applications can access clinical information through a data store. It adds a security layer based on open standards including OAuth2 and OpenID Connect, to FHIR interfaces to enable integration with EHR systems. Using SMART on FHIR provides at least three important benefits:
16+
- Applications have a known method for obtaining authentication/authorization to a FHIR repository
17+
- Users accessing a FHIR repository with SMART on FHIR are restricted to resources associated with the user, rather than having access to all data in the repository
18+
- Users have the ability to grant applications access to a further limited set of their data by using SMART clinical scopes.
1619

17-
Authentication is based on OAuth2. But because SMART on FHIR uses parameter naming conventions that aren’t immediately compatible with Azure Active Directory (Azure AD), the Azure API for FHIR has a built-in Azure AD SMART on FHIR proxy that enables a subset of the SMART on FHIR launch sequences. Specifically, the proxy enables the [EHR launch sequence](https://hl7.org/fhir/smart-app-launch/#ehr-launch-sequence).
20+
<!---SMART Implementation Guide v1.0.0 is supported by Azure API for FHIR and Azure API Management (APIM). This is our recommended approach, as it enabled Health IT developers to comply with 21st Century Act Criterion §170.315(g)(10) Standardized API for patient and population services.
1821
19-
This tutorial describes how to use the proxy to enable SMART on FHIR applications with FHIR Service.
22+
Sample demonstrates and list steps that can be referenced to pass ONC G(10) with Inferno test suite.
2023
21-
## Prerequisites
22-
23-
- An instance of the FHIR Service
24-
- [.NET Core 2.2](https://dotnet.microsoft.com/download/dotnet-core/2.2)
24+
--->
2525

26-
## Configure Azure AD registrations
26+
One of the main purposes of the specifications is to describe how an application should discover authentication endpoints for an FHIR server and start an authentication sequence. SMART on FHIR uses parameter naming conventions that aren’t immediately compatible with Azure Active Directory (Azure AD), the Azure API for FHIR has a built-in Azure AD SMART on FHIR proxy that enables a subset of the SMART on FHIR launch sequences. Specifically, the proxy enables the [EHR launch sequence](https://hl7.org/fhir/smart-app-launch/#ehr-launch-sequence).
2727

28-
SMART on FHIR requires that `Audience` has an identifier URI equal to the URI of the FHIR service. The standard configuration of the FHIR service uses an `Audience` value of `https://azurehealthcareapis.com`. However, you can also set a value matching the specific URL of your FHIR service (for example `https://MYFHIRAPI.fhir.azurehealthcareapis.com`). This is required when working with the SMART on FHIR proxy.
28+
Below tutorial describes steps to enable SMART on FHIR applications with FHIR Service.
2929

30-
You'll also need a client application registration. Most SMART on FHIR applications are single-page JavaScript applications. So you should follow the instructions for configuring a [public client application in Azure AD](register-public-azure-ad-client-app.md).
31-
32-
After you complete these steps, you should have:
33-
34-
- A FHIR server with the audience set to `https://MYFHIRAPI.fhir.azurehealthcareapis.com`, where `MYFHIRAPI` is the name of your FHIR service instance.
35-
- A public client application registration. Make a note of the application ID for this client application.
30+
## Prerequisites
3631

37-
### Set admin consent for your app
32+
- An instance of the FHIR Service
33+
- .NET SDK 6.0
34+
- [Enable cross-origin resource sharing (CORS)](configure-cross-origin-resource-sharing.md)
35+
- [Register public client application in Azure AD](/register-public-azure-ad-client-app.md)
36+
- After registering the application, make note of the applicationId for client application.
37+
38+
<!--- Tutorial : To enable SMART on FHIR using APIM, follow below steps
39+
Step 1 : Set up FHIR SMART user role
40+
Follow the steps listed under section [Manage Users: Assign Users to Role](https://learn.microsoft.com/azure/active-directory/fundamentals/active-directory-users-assign-role-azure-portal). Any user added to this role will be able to access the FHIR Service if their requests comply with the SMART on FHIR implementation Guide, such as request having access token which includes a fhirUser claim and a clinical scopes claim. The access granted to the users in this role will then be limited by the resources associated to their fhirUser compartment and the restrictions in the clinical scopes.
41+
42+
Step 2 : Deploy the necessary components to set up the FHIR server integrated with APIM in production. Follow ReadMe
43+
Step 3 : Load US Core profiles
44+
Step 4 : Create Azure AD custom policy using this README --->
45+
46+
Lets go over individual steps to enable SMART on FHIR
47+
## Step 1 : Set admin consent for your client application
3848

3949
To use SMART on FHIR, you must first authenticate and authorize the app. The first time you use SMART on FHIR, you also must get administrative consent to let the app access your FHIR resources.
4050

@@ -49,13 +59,18 @@ To add yourself or another user as owner of an app:
4959
3. Search for the app registration you created, and then select it.
5060
4. In the left menu, under **Manage**, select **Owners**.
5161
5. Select **Add owners**, and then add yourself or the user you want to have admin consent.
52-
6. Select **Save**.
62+
6. Select **Save**
63+
64+
65+
## Step 2 : Configure Azure AD registrations
66+
67+
SMART on FHIR requires that `Audience` has an identifier URI equal to the URI of the FHIR service. The standard configuration of the FHIR service uses an `Audience` value of `https://azurehealthcareapis.com`. However, you can also set a value matching the specific URL of your FHIR service (for example `https://MYFHIRAPI.fhir.azurehealthcareapis.com`). This is required when working with the SMART on FHIR proxy.
5368

54-
## Enable the SMART on FHIR proxy
69+
## Step 3: Enable the SMART on FHIR proxy
5570

5671
Enable the SMART on FHIR proxy in the **Authentication** settings for your FHIR instance by selecting the **SMART on FHIR proxy** check box.
57-
Enable CORS : Because most SMART on FHIR applications are single-page JavaScript apps, you need to [enable cross-origin resource sharing (CORS)](configure-cross-origin-resource-sharing.md)
58-
Configure the reply URL: The SMART on FHIR proxy acts as an intermediary between the SMART on FHIR app and Azure AD. The authentication reply (the authentication code) must go to the SMART on FHIR proxy instead of the app itself. The proxy then forwards the reply to the app.
72+
73+
The SMART on FHIR proxy acts as an intermediary between the SMART on FHIR app and Azure AD. The authentication reply (the authentication code) must go to the SMART on FHIR proxy instead of the app itself. The proxy then forwards the reply to the app.
5974

6075
Because of this two-step relay of the authentication code, you need to set the reply URL (callback) for your Azure AD client application to a URL that is a combination of the reply URL for the SMART on FHIR proxy and the reply URL for the SMART on FHIR app. The combined reply URL takes this form:
6176

@@ -83,11 +98,12 @@ Add the reply URL to the public client application that you created earlier for
8398

8499
<!---![Reply URL configured for the public client](media/tutorial-smart-on-fhir/configure-reply-url.png)--->
85100

86-
## Get a test patient
101+
102+
## Step 4 : Get a test patient
87103

88104
To test the FHIR service and the SMART on FHIR proxy, you'll need to have at least one patient in the database. If you've not interacted with the API yet, and you don't have data in the database, see [Access the FHIR service using Postman](./../fhir/use-postman.md) to load a patient. Make a note of the ID of a specific patient.
89105

90-
## Download the SMART on FHIR app launcher
106+
## Step 5 : Download the SMART on FHIR app launcher
91107

92108
The open-source [FHIR Server for Azure repository](https://github.com/Microsoft/fhir-server) includes a simple SMART on FHIR app launcher and a sample SMART on FHIR app. In this tutorial, use this SMART on FHIR launcher locally to test the setup.
93109

@@ -121,7 +137,7 @@ Use this command to run the application:
121137
dotnet run
122138
```
123139

124-
## Test the SMART on FHIR proxy
140+
## Step 6 : Test the SMART on FHIR proxy
125141

126142
After you start the SMART on FHIR app launcher, you can point your browser to `https://localhost:5001`, where you should see the following screen:
127143

0 commit comments

Comments
 (0)