Skip to content

Commit dc1491d

Browse files
authored
Merge pull request #288041 from KendalBond007/APIforFHIRbatch12_Oct24
APIforFHIRbatch12_Oct24
2 parents 6fd84ef + 01415a2 commit dc1491d

7 files changed

+73
-75
lines changed

articles/healthcare-apis/azure-api-for-fhir/tutorial-member-match.md

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -10,48 +10,46 @@ author: expekesheth
1010
ms.date: 09/27/2023
1111
---
1212

13-
# $member-match operation for Azure API for FHIR
13+
# Use the $member-match operation for Azure API for FHIR
1414

15-
[!INCLUDE [retirement banner](../includes/healthcare-apis-azure-api-fhir-retirement.md)]
15+
[!INCLUDE[retirement banner](../includes/healthcare-apis-azure-api-fhir-retirement.md)]
1616

17-
[$member-match](http://hl7.org/fhir/us/davinci-hrex/2020Sep/OperationDefinition-member-match.html) is an operation that is defined as part of the Da Vinci Health Record Exchange (HRex). In this guide, we'll walk through what $member-match is and how to use it.
17+
[$member-match](http://hl7.org/fhir/us/davinci-hrex/2020Sep/OperationDefinition-member-match.html) is an operation that is defined as part of the Da Vinci Health Record Exchange (HRex). In this guide, we walk through what `$member-match` is and how to use it.
1818

1919
## Overview of $member-match
2020

21-
The $member-match operation was created to help with the payer-to-payer data exchange, by allowing a new payer to get a unique identifier for a patient from the patient’s previous payer. The $member-match operation
22-
requires three pieces of information to be passed in the body of the request:
21+
The `$member-match` operation was created to help with the payer-to-payer data exchange, by allowing a new payer to get a unique identifier for a patient from the patient’s previous payer. The `$member-match` operation requires three pieces of information to be passed in the body of the request:
2322

2423
* Patient demographics
2524

2625
* The old coverage information
2726

2827
* The new coverage information (not required based on our implementation)
2928

30-
After the data is passed in, the Azure API for FHIR validates that it can find a patient that exactly matches the demographics passed in with the old coverage information passed in. If a result is found, the response will be a bundle with the original patient data plus a new identifier added in from the old payer, and the old coverage information.
29+
After the data is passed in, the Azure API for FHIR validates that it can find a patient that exactly matches the demographics passed in with the old coverage information passed in. If a result is found, the response is a bundle with the original patient data plus a new identifier added in from the old payer, and the old coverage information.
3130

3231
> [!NOTE]
33-
> The specification describes passing in and back the new
34-
coverage information. We've decided to omit that data to keep the results smaller.
32+
> The specification describes passing the new coverage information in and back. We've decided to omit that data to keep the results smaller.
3533
3634
## Example of $member-match
3735

38-
To use $member-match, use the following call:
36+
To use `$member-match`, use the following call.
3937

4038
`POST {{fhirurl}}/Patient/$member-match`
4139

42-
You'll need to include a parameters resource in the body that includes the patient, the old coverage, and the new coverage. To see a JSON representation, see [$member-match example request](http://hl7.org/fhir/us/davinci-hrex/2020Sep/Parameters-member-match-in.json.html).
40+
You need to include a parameters resource in the body that includes the patient, the old coverage, and the new coverage. For a JSON representation, see [$member-match example request](http://hl7.org/fhir/us/davinci-hrex/2020Sep/Parameters-member-match-in.json.html).
4341

44-
If a single match is found, you'll receive a 200 response with another identifier added:
42+
If a single match is found, you receive a 200 response with another identifier added.
4543

4644
:::image type="content" source="media/cms-tutorials/two-hundred-response.png" alt-text="200 hundred response code.":::
4745

48-
If the $member-match can't find a unique match, you'll receive a 422 response with an error code.
46+
If the `$member-match` can't find a unique match, you receive a 422 response with an error code.
4947

5048
## Next steps
5149

52-
In this guide, you've learned about the $member-match operation. Next, you can learn about testing the Da Vinci Payer Data Exchange IG in Touchstone, which requires the $member-match operation.
50+
In this guide, you learned about the `$member-match` operation. Next, you can learn about testing the Da Vinci Payer Data Exchange IG in Touchstone, which requires the `$member-match` operation.
5351

5452
>[!div class="nextstepaction"]
5553
>[DaVinci PDex](../fhir/davinci-pdex-tutorial.md)
5654
57-
FHIR® is a registered trademark of [HL7](https://hl7.org/fhir/) and is used with the permission of HL7.
55+
[!INCLUDE[FHIR trademark statement](../includes/healthcare-apis-fhir-trademark.md)]

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@ ms.custom: devx-track-js
1212

1313
---
1414

15-
# Deploy JavaScript app to read data from Azure API for FHIR
15+
# Deploy a JavaScript app to read data from Azure API for FHIR
1616

17-
[!INCLUDE [retirement banner](../includes/healthcare-apis-azure-api-fhir-retirement.md)]
17+
[!INCLUDE[retirement banner](../includes/healthcare-apis-azure-api-fhir-retirement.md)]
1818

19-
In this tutorial, you'll deploy a small JavaScript app, which reads data from a FHIR service. The steps in this tutorial are:
19+
In this tutorial, you deploy a small JavaScript app which reads data from a FHIR service. The steps in this tutorial are:
2020

2121
1. Deploy a FHIR server
2222
1. Register a public client application
@@ -25,7 +25,7 @@ In this tutorial, you'll deploy a small JavaScript app, which reads data from a
2525

2626
## Prerequisites
2727

28-
Before starting this set of tutorials, you'll need the following items:
28+
You need the following before starting this set of tutorials.
2929
1. An Azure subscription
3030
1. A Microsoft Entra tenant
3131
1. [Postman](https://www.getpostman.com/) installed
@@ -51,4 +51,4 @@ Now that you have your Azure API for FHIR deployed, you're ready to register a p
5151
>[!div class="nextstepaction"]
5252
>[Register public client application](tutorial-web-app-public-app-reg.md)
5353
54-
FHIR® is a registered trademark of [HL7](https://hl7.org/fhir/) and is used with the permission of HL7.
54+
[!INCLUDE[FHIR trademark statement](../includes/healthcare-apis-fhir-trademark.md)]

articles/healthcare-apis/azure-api-for-fhir/tutorial-web-app-public-app-reg.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ ms.date: 09/27/2023
1212

1313
# Client application registration for Azure API for FHIR
1414

15-
[!INCLUDE [retirement banner](../includes/healthcare-apis-azure-api-fhir-retirement.md)]
15+
[!INCLUDE[retirement banner](../includes/healthcare-apis-azure-api-fhir-retirement.md)]
1616

17-
In the previous tutorial, you deployed and set up your Azure API for FHIR. Now that you have your Azure API for FHIR setup, we’ll register a public client application. You can read through the full [register a public client app](register-public-azure-ad-client-app.md) how-to guide for more details or troubleshooting, but we’ve called out the major steps for this tutorial in this article.
17+
In the previous tutorial, you deployed and set up your Azure API for FHIR®. Now that you have your Azure API for FHIR setup, we register a public client application. You can read through the full [register a public client app](register-public-azure-ad-client-app.md) how-to guide for more details or troubleshooting. We call out the major steps in this tutorial.
1818

1919
1. Navigate to Microsoft Entra ID
2020
1. Select **App Registration** --> **New Registration**
@@ -37,15 +37,15 @@ If you’ve [written your web app](tutorial-web-app-write-web-app.md) to connect
3737

3838
1. To add a new platform configuration, select **Web**.
3939

40-
1. Set up the redirect URI in preparation for when you create your web application in the fourth part of this tutorial. To do this, add `https://\<WEB-APP-NAME>.azurewebsites.net` to the redirect URI list. If you choose a different name during the step where you [write your web app](tutorial-web-app-write-web-app.md), you’ll need to come back and update this.
40+
1. Set up the redirect URI in preparation for when you create your web application. To do this, add `https://\<WEB-APP-NAME>.azurewebsites.net` to the redirect URI list. If you choose a different name during the step where you [write your web app](tutorial-web-app-write-web-app.md), you’ll need to come back and update this.
4141

4242
1. Select the **Access Token** and **ID token** check boxes.
4343

4444
:::image type="content" source="media/tutorial-web-app/web-app-authentication.png" alt-text="Screenshot of the app Authentication settings blade, with the steps to add a platform highlighted.":::
4545

4646
## Add API permissions
4747

48-
Now that you have set up the correct authentication, set the API permissions:
48+
Now that you have set up the correct authentication, set the API permissions.
4949

5050
1. Select **API permissions** and select **Add a permission**.
5151
1. Under **APIs my organization uses**, search for Azure Health Data Services.
@@ -60,4 +60,4 @@ You now have a public client application. In the next tutorial, we’ll walk thr
6060
>[!div class="nextstepaction"]
6161
>[Test client application in Postman](tutorial-web-app-test-postman.md)
6262
63-
FHIR&#174; is a registered trademark of [HL7](https://hl7.org/fhir/) and is used with the permission of HL7.
63+
[!INCLUDE[FHIR trademark statement](../includes/healthcare-apis-fhir-trademark.md)]

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

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -12,25 +12,26 @@ ms.date: 09/27/2023
1212

1313
# Testing the FHIR API on Azure API for FHIR
1414

15-
[!INCLUDE [retirement banner](../includes/healthcare-apis-azure-api-fhir-retirement.md)]
15+
[!INCLUDE[retirement banner](../includes/healthcare-apis-azure-api-fhir-retirement.md)]
1616

17-
In the previous tutorial, you deployed the Azure API for FHIR and registered your client application. You're now ready to test your Azure API for FHIR.
17+
In the previous tutorial, you deployed the Azure API for FHIR&reg; and registered your client application. You're now ready to test your Azure API for FHIR.
1818

19-
## Retrieve capability statement
19+
## Retrieve the capability statement
2020

21-
First we'll get the capability statement for your Azure API for FHIR.
21+
First we get the capability statement for your Azure API for FHIR.
2222
1. Open Postman.
23-
1. Retrieve the capability statement by doing `GET https://\<FHIR-SERVER-NAME>.azurehealthcareapis.com/metadata`. In the image below the FHIR server name is **fhirserver**.
23+
1. Retrieve the capability statement by using `GET https://\<FHIR-SERVER-NAME>.azurehealthcareapis.com/metadata`. In the image below the FHIR server name is **fhirserver**.
2424

2525
![Capability Statement](media/tutorial-web-app/postman-capability-statement.png)
2626

27-
Next we'll attempt to retrieve a patient. To retrieve a patient, enter `GET https://\<FHIR-SERVER-NAME>.azurehealthcareapis.com/Patient`. You’ll receive a 401 Unauthorized error. This error is because you haven't proven that you should have access to patient data.
28-
29-
## Get patient from FHIR server
27+
Next we attempt to retrieve a patient. To retrieve a patient, use `GET https://\<FHIR-SERVER-NAME>.azurehealthcareapis.com/Patient`. You receive a `401 Unauthorized` error because you haven't proven you should have access to patient data.
3028

3129
![Failed Patient](media/tutorial-web-app/postman-patient-authorization-failed.png)
3230

31+
## Get patient from FHIR server
32+
3333
In order to gain access, you need an access token.
34+
3435
1. Select **Authorization** and set the Type to **OAuth2.0** in Postman.
3536
1. Select **Get New Access Token**.
3637
1. Fill in the fields and select **Request Token**. Below you can see the values for each field for this tutorial.
@@ -50,12 +51,13 @@ In order to gain access, you need an access token.
5051

5152
4. Sign in with your credentials and select **Accept**
5253
1. Scroll down on the result and select **Use Token**
53-
1. Select **Send** again at the top and this time you should get a result
54+
1. Select **Send** again at the top and this time you should get a result:
55+
5456
![Success Patient](media/tutorial-web-app/postman-patient-authorization-success.png)
5557

5658
## Post patient into FHIR server
5759

58-
Now you have access, you can create a new patient. Here's a sample of a simple patient you can add into your FHIR server. Enter this `json` into the **Body** section of Postman.
60+
Now that you have access, you can create a new patient. Here's a sample of a simple patient you can add into your FHIR server. Enter this `json` into the **Body** section of Postman.
5961

6062
``` json
6163
{
@@ -81,10 +83,11 @@ Now you have access, you can create a new patient. Here's a sample of a simple p
8183
"birthDate": "1960-12-25"
8284
}
8385
```
84-
This POST will create a new patient in your FHIR server with the name James Tiberious Kirk.
86+
This POST creates a new patient in your FHIR server with the name James Tiberious Kirk.
87+
8588
![Post Patient](media/tutorial-web-app/postman-post-patient.png)
8689

87-
If you do the GET command to retrieve a patient again, you'll see James Tiberious Kirk listed in the output.
90+
If you use the GET command to retrieve a patient again, you'll see James Tiberious Kirk listed in the output.
8891

8992
> [!NOTE]
9093
> When sending requests to the Azure API for FHIR, you need to ensure that you've set the content-type header to `application/json`
@@ -103,4 +106,4 @@ Now that you can successfully connect to your client application, you’re ready
103106
>[!div class="nextstepaction"]
104107
>[Write a web application](tutorial-web-app-write-web-app.md)
105108
106-
FHIR&#174; is a registered trademark of [HL7](https://hl7.org/fhir/) and is used with the permission of HL7.
109+
[!INCLUDE[FHIR trademark statement](../includes/healthcare-apis-fhir-trademark.md)]

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

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,21 +10,21 @@ author: expekesheth
1010
ms.date: 09/27/2023
1111
---
1212

13-
# Write Azure web application to read FHIR data in Azure API for FHIR
13+
# Write an Azure web application to read FHIR data in Azure API for FHIR
1414

15-
[!INCLUDE [retirement banner](../includes/healthcare-apis-azure-api-fhir-retirement.md)]
15+
[!INCLUDE[retirement banner](../includes/healthcare-apis-azure-api-fhir-retirement.md)]
1616

17-
Now that you're able to connect to your FHIR server and POST data, you’re ready to write a web application that will read FHIR data. In this final step of the tutorial, we’ll walk through writing and accessing the web application.
17+
Once you're able to connect to your FHIR&reg; server and POST data, you’re ready to write a web application that will read FHIR data. In this final step of the tutorial, we walk through writing and accessing the web application.
1818

1919
## Create web application
20-
In Azure, select **Create a resource** and select **Web App**. Make sure to name your web application whatever you specified in the redirect URI for your client application or go back and update the redirect URI with the new name.
20+
In Azure, select **Create a resource** and select **Web App**. Make sure to name your web application whatever you specified in the redirect URI for your client application, or go back and update the redirect URI with the new name.
2121

2222
![Create Web Application](media/tutorial-web-app/create-web-app.png)
2323

24-
Once the web application is available, **Go to resource**. Select **App Service Editor (Preview)** under Development Tools on the right and then select **Go**. Selecting Go will open up the App Service Editor. Right select in the grey space under *Explore* and create a new file called **index.html**.
24+
Once the web application is available, select **Go to resource**. Select **App Service Editor (Preview)** under Development Tools on the right and then select **Go**. Selecting **Go** opens up the App Service Editor. Right select in the grey space under *Explore* and create a new file called **index.html**.
2525

26-
Included is the code that you can input into **index.html**. You’ll need to update the following items:
27-
* **clientId** - Update with your client application ID. This ID will be the same ID you pulled when retrieving your token
26+
The following is code you can input into **index.html**. You’ll need to update the following items.
27+
* **clientId** - Update with your client application ID. This ID is the same ID you pulled when retrieving your token
2828
* **authority** - Update with your Microsoft Entra tenant ID
2929
* **FHIRendpoint** - Update the FHIRendpoint to have your FHIR service name
3030
* **scopes** - Update to reflect the full URL for your audience
@@ -146,9 +146,9 @@ From here, you can go back to your web application resource and open the URL fou
146146

147147
## Next Steps
148148

149-
You’ve successfully deployed the Azure API for FHIR, registered a public client application, tested access, and created a small web application. Check out the Azure API for FHIR supported features as a next step.
149+
You’ve successfully deployed the Azure API for FHIR, registered a public client application, tested access, and created a small web application. As a next step, check out the Azure API for FHIR supported features.
150150

151151
>[!div class="nextstepaction"]
152152
>[Supported Features](fhir-features-supported.md)
153153
154-
FHIR&#174; is a registered trademark of [HL7](https://hl7.org/fhir/) and is used with the permission of HL7.
154+
[!INCLUDE[FHIR trademark statement](../includes/healthcare-apis-fhir-trademark.md)]

articles/healthcare-apis/azure-api-for-fhir/use-custom-headers.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,13 @@ ms.date: 09/27/2023
1212

1313
# Add custom HTTP headers to audit logs in FHIR service
1414

15-
[!INCLUDE [retirement banner](../includes/healthcare-apis-azure-api-fhir-retirement.md)]
15+
[!INCLUDE[retirement banner](../includes/healthcare-apis-azure-api-fhir-retirement.md)]
1616

17-
[!INCLUDE [Specific IP ranges for storage account](../includes/custom-header-auditlog.md)]
17+
[!INCLUDE[Specific IP ranges for storage account](../includes/custom-header-auditlog.md)]
1818

1919
## Next steps
2020

21-
In this article, you learned how to add data to audit logs by using custom headers in the Azure API for FHIR. For information about Azure API for FHIR configuration settings, see
21+
In this article, you learned how to add data to audit logs by using custom headers in the Azure API for FHIR&reg;. For information about Azure API for FHIR configuration settings, see
2222

2323
>[!div class="nextstepaction"]
2424
>[Configure Azure RBAC](configure-azure-rbac.md)
@@ -38,5 +38,4 @@ In this article, you learned how to add data to audit logs by using custom heade
3838
>[!div class="nextstepaction"]
3939
>[Configure Private Link](configure-private-link.md)
4040
41-
FHIR&#174; is a registered trademark of [HL7](https://hl7.org/fhir/) and is used with the permission of HL7.
42-
41+
[!INCLUDE[FHIR trademark statement](../includes/healthcare-apis-fhir-trademark.md)]

0 commit comments

Comments
 (0)