Skip to content

Commit d1aa476

Browse files
authored
Merge pull request #99804 from CaitlinV39/master
2 New Pages & Resource Page Update
2 parents 6c12c9f + eb9315b commit d1aa476

File tree

7 files changed

+33
-22
lines changed

7 files changed

+33
-22
lines changed

articles/healthcare-apis/TOC.yml

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,17 @@
2424
- name: Tutorials
2525
expanded: false
2626
items:
27-
- name: 1. Get started with Azure API for FHIR
28-
href: tutorial-2-setup-environment.md
29-
- name: 2. Set up application configuration
30-
href: tutorial-1-decision-flow.md
31-
- name: 3. Configure additional settings
32-
href: azure-api-for-fhir-additional-settings.md
33-
- name: 4. Write an application
34-
href: tutorial-3-connect-to-endpoint.md
27+
- name: Write an application to connect to FHIR endpoint
28+
expanded: false
29+
items:
30+
- name: 1. Get started with Azure API for FHIR
31+
href: tutorial-2-setup-environment.md
32+
- name: 2. Set up application configuration
33+
href: tutorial-1-decision-flow.md
34+
- name: 3. Configure additional settings
35+
href: azure-api-for-fhir-additional-settings.md
36+
- name: 4. Write an application
37+
href: tutorial-3-connect-to-endpoint.md
3538
- name: Access FHIR API with Postman
3639
href: access-fhir-postman-tutorial.md
3740
- name: Use SMART on FHIR proxy

articles/healthcare-apis/fhir-paas-portal-quickstart.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -44,17 +44,16 @@ Confirm creation and await FHIR API deployment.
4444

4545
## Additional settings
4646

47-
Click **Next: Additional settings** to configure the authority, audience, identity object IDs that should be allowed to access this Azure API for FHIR, enable SMART on FHIR if needed, and configure Cosmos DB throughput:
47+
Click **Next: Additional settings** to configure the authority, audience, identity object IDs that should be allowed to access this Azure API for FHIR, enable SMART on FHIR if needed, and configure database throughput:
4848

4949
- **Authority:** You can specify different Azure AD tenant from the one that you are logged into as authentication authority for the service.
5050
- **Audience:** You can specify audience, that is different from https:\//azurehealthcareapis.com.
51-
- **Allowed object IDs:** You can specify identity object IDs that should be allowed to access this Azure API for FHIR
51+
- **Allowed object IDs:** You can specify identity object IDs that should be allowed to access this Azure API for FHIR. You can learn more on finding the object id for users and service principals in the [Find identity object IDs](find-identity-object-ids.md) how-to guide.
5252
- **Smart On FHIR proxy:** You can enable SMART on FHIR proxy. For details on how to configure SMART on FHIR proxy see tutorial [Azure API for FHIR SMART on FHIR proxy](https://docs.microsoft.com/azure/healthcare-apis/use-smart-on-fhir-proxy)
53-
- **Cosmos DB throughput:** Azure API for FHIR relies on Cosmos DB as its underlying database. Here you can specify Cosmos DB throughput settings for your Azure API for FHIR. You can change this setting later in the Cosmos DB blade. For details on Cosmos DB RUs please read [Request Units in Azure Cosmos DB](https://docs.microsoft.com/azure/cosmos-db/request-units)
53+
- **Provisioned throughput (RU/s):** Here you can specify throughput settings for the underlying database for your Azure API for FHIR. You can change this setting later in the Database blade. For more details, please see the [configure database settings](configure-database.md) page.
5454

55-
![Configure allowed object IDs](media/quickstart-paas-portal/configure-audience.png)
5655

57-
See [how to find identity object IDs](find-identity-object-ids.md) for details on how to locate identity object IDs for users and service principals.
56+
![Configure allowed object IDs](media/quickstart-paas-portal/configure-audience.png)
5857

5958
## Fetch FHIR API capability statement
6059

89.7 KB
Loading
19 KB
Loading
-141 KB
Loading

articles/healthcare-apis/register-public-azure-ad-client-app.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ ms.author: mihansen
1212

1313
# Register a public client application in Azure Active Directory
1414

15-
In this article, you'll learn how to register a public application in Azure Active Directory. This is preparation for deploying FHIR API in Azure.
15+
In this article, you'll learn how to register a public application in Azure Active Directory.
1616

1717
Client application registrations are Azure Active Directory representations of applications that can authenticate and ask for API permissions on behalf of a user. Public clients are applications such as mobile applications and single page javascript applications that can't keep secrets confidential. The procedure is similar to [registering a confidential client](register-confidential-azure-ad-client-app.md), but since public clients can't be trusted to hold an application secret, there's no need to add one.
1818

@@ -28,7 +28,7 @@ Client application registrations are Azure Active Directory representations of a
2828

2929
## Application registration overview
3030

31-
1. Give the application with a display name.
31+
1. Give the application a display name.
3232

3333
2. Provide a reply URL. The reply URL is where authentication codes will be returned to the client application. You can add more reply URLs and edit existing ones later.
3434

@@ -38,15 +38,22 @@ Client application registrations are Azure Active Directory representations of a
3838

3939
Similarly to the [confidential client application](register-confidential-azure-ad-client-app.md), you'll need to select which API permissions this application should be able to request on behalf of users:
4040

41-
1. Open the **API permissions** and select your [FHIR API Resource Application Registration](register-resource-azure-ad-client-app.md):
41+
1. Open the **API permissions**. If you are using the Azure API for FHIR, you will add a permission to the Azure Healthcare APIs by searching for Azure Healthcare APIs under **APIs my organization uses** (image below). If you are referencing a different Resource Application, select your [FHIR API Resource Application Registration](register-resource-azure-ad-client-app.md) that you created previously under **My APIs**:
4242

43-
![Azure portal. New public API Permissions.](media/how-to-aad/portal-aad-register-new-app-registration-PUB-CLIENT-API-PERMISSIONS.png)
43+
![Azure portal. New public API permissions - Azure API for FHIR Default](media/public-client-app/api-permissions.png)
4444

45-
2. Select the scopes that you would like the application to be able to request.
45+
46+
2. Select the permissions that you would like the application to be able to request:
47+
![Azure portal. App permissions](media/public-client-app/app-permissions.png)
48+
49+
## Validate FHIR server authority
50+
If the application you registered in this article and your FHIR server are in the same Azure AD tenant, you are good to proceed to the next steps.
51+
52+
If you configure your client application in a different Azure AD tenant from your FHIR server, you will need to update the **Authority**. In Azure API for FHIR, you do set the Authority under Settings --> Authentication. Set your Authority to **https://login.microsoftonline.com/\<TENANT-ID>**.
4653

4754
## Next steps
4855

49-
In this article, you've learned how to register a public client application in Azure Active Directory. Next, learn more about using SMART on FHIR.
56+
In this article, you've learned how to register a public client application in Azure Active Directory. Next, test access to your FHIR server using Postman.
5057

5158
>[!div class="nextstepaction"]
52-
>[Azure API for FHIR SMART on FHIR proxy](use-smart-on-fhir-proxy.md)
59+
>[Access Azure API for FHIR with Postman](access-fhir-postman-tutorial.md)

articles/healthcare-apis/register-resource-azure-ad-client-app.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ ms.author: mihansen
1414

1515
In this article, you'll learn how to register a resource (or API) application in Azure Active Directory. A resource application is an Azure Active Directory representation of the FHIR server API itself and client applications can request access to the resource when authenticating. The resource application is also known as the *audience* in OAuth parlance.
1616

17+
If you are using the Azure API for FHIR, a resource application is automatically created when you deploy the service. As long as you are using the Azure API for FHIR in the same Azure Active Directory tenant as you are deploying your application, you can skip this how-to-guide and instead deploy your Azure API for FHIR to get started.
18+
1719
## App registrations in Azure portal
1820

1921
1. In the [Azure portal](https://portal.azure.com), on the left navigation panel, click **Azure Active Directory**.
@@ -40,9 +42,9 @@ A resource application has an identifier URI (Application ID URI), which clients
4042

4143
3. Enter the identifier URI and click **Save**. A good identifier URI would be the URI of your FHIR server.
4244

43-
4. Click **Add a scope** and add any scopes that you would like to define for your API. Azure AD does not currently allow slashes (`/`) in scope names. We recommend using `$` instead. A scope like `patient/*.read` would be `patient$*.read`.
45+
4. Click **Add a scope** and add any scopes that you would like to define for your API. You are required to add at least one scope in order to grant permissions to your resource application in the future. If you don't have any specific scopes you want to add, you can add user_impersonation as a scope.
4446

45-
![Audience and scope](media/how-to-aad/portal-aad-register-new-app-registration-AUD-SCOPE.png)
47+
![Audience and scope](media/how-to-aad/portal-aad-register-new-app-registration-AUD-SCOPE.png)
4648

4749
## Define application roles
4850

0 commit comments

Comments
 (0)