Skip to content

Commit 6d3b0b3

Browse files
huypubhuypub
authored
Merge pull request #92417 from MicrosoftDocs/release-ga-healthcare-apis
Release ga healthcare apis
2 parents 7566bf1 + 00a9d7c commit 6d3b0b3

19 files changed

+435
-56
lines changed

‎articles/healthcare-apis/TOC.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,17 @@
2525
href: configure-cross-origin-resource-sharing.md
2626
- name: Configure Cosmos DB
2727
href: configure-cosmos-db.md
28+
- name: Use Custom HTTP headers to add data to Audit Logs
29+
href: use-custom-headers.md
2830
- name: Tutorials
2931
expanded: false
3032
items:
33+
- name: 1. Set up Azure AD configuration
34+
href: tutorial-1-decision-flow.md
35+
- name: 2. Setup Development Environment
36+
href: tutorial-2-setup-environment.md
37+
- name: 3. Connect to endpoint
38+
href: tutorial-3-connect-to-endpoint.md
3139
- name: Access FHIR API with Postman
3240
href: access-fhir-postman-tutorial.md
3341
- name: Use SMART on FHIR proxy

‎articles/healthcare-apis/configure-cosmos-db.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,4 @@ To change this setting in the Azure portal, you can navigate to your Azure API f
1818

1919
***Note:** Higher value means higher Cosmos DB throughput and higher cost of the service.
2020

21-
![](media/cosmosdb/cosmosdb-config.png)
21+
![Config Cosmos DB](media/cosmosdb/cosmosdb-config.png)

‎articles/healthcare-apis/fhir-faq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Azure API for FHIR (PaaS): We support version 3.0.1
2626

2727
FHIR Server for Azure (OSS): We support version 4.0.0, the most recent version of the FHIR specification, in addition to version 3.0.1.
2828

29-
See [Supported Features](fhir-features-supported.md) for details. Read about what has changed between versions in [HL7 FHIR's Version History](http://hl7.org/fhir/R4/history.html)
29+
See [Supported Features](fhir-features-supported.md) for details. Read about what has changed between versions in [HL7 FHIR's Version History](https://hl7.org/fhir/R4/history.html)
3030

3131
## OSS and Azure API for FHIR
3232

‎articles/healthcare-apis/fhir-paas-cli-quickstart.md

Lines changed: 17 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ author: hansenms
66
ms.service: healthcare-apis
77
ms.subservice: fhir
88
ms.topic: quickstart
9-
ms.date: 02/07/2019
9+
ms.date: 10/15/2019
1010
ms.author: mihansen
1111
---
1212

@@ -18,28 +18,25 @@ If you don't have an Azure subscription, create a [free account](https://azure.m
1818

1919
[!INCLUDE [cloud-shell-try-it.md](../../includes/cloud-shell-try-it.md)]
2020

21-
## Create Azure Resource Manager template
21+
## Add HealthcareAPIs extension
2222

23-
Create an Azure Resource Manager template with the following content:
24-
25-
[!code-json[](samples/azuredeploy.json)]
26-
27-
Save it with the name `azuredeploy.json`
28-
29-
## Create Azure Resource Manager parameter file
23+
```azurecli-interactive
24+
az extension add --name healthcareapis
25+
```
3026

31-
Create an Azure Resource Manager template parameter file with the following content:
27+
Get a list of commands for HealthcareAPIs:
3228

33-
[!code-json[](samples/azuredeploy.parameters.json)]
29+
```azurecli-interactive
30+
az healthcareapis --help
31+
```
3432

35-
Save it with the name `azuredeploy.parameters.json`
33+
## Locate your identity object ID
3634

37-
The object ID values `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` and `yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy` correspond to the object IDs of specific Azure Active Directory users or service principals in the directory associated with the subscription. If you would like to know the object ID of a specific user, you can find it with a command like:
35+
Object ID values are guids that correspond to the object IDs of specific Azure Active Directory users or service principals in the directory associated with the subscription. If you would like to know the object ID of a specific user, you can find it with a command like:
3836

3937
```azurecli-interactive
40-
az ad user show --upn-or-object-id [email protected] | jq -r .objectId
38+
az ad user show --id [email protected] | jq -r .objectId
4139
```
42-
4340
Read the how-to guide on [finding identity object IDs](find-identity-object-ids.md) for more details.
4441

4542
## Create Azure Resource Group
@@ -50,20 +47,20 @@ Pick a name for the resource group that will contain the Azure API for FHIR and
5047
az group create --name "myResourceGroup" --location westus2
5148
```
5249

53-
## Deploy the Azure API for FHIR account
54-
55-
Use the template (`azuredeploy.json`) and the template parameter file (`azuredeploy.parameters.json`) to deploy the Azure API for FHIR:
50+
## Deploy the Azure API for FHIR
5651

5752
```azurecli-interactive
58-
az group deployment create -g "myResourceGroup" --template-file azuredeploy.json --parameters @{azuredeploy.parameters.json}
53+
az healthcareapis create --resource-group myResourceGroup --name nameoffhiraccount --kind fhir-r4 --location westus2 --access-policies-object-id "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
5954
```
6055

56+
where `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` is the identity object ID for a user or service principal that you would like to have access to the FHIR API.
57+
6158
## Fetch FHIR API capability statement
6259

6360
Obtain a capability statement from the FHIR API with:
6461

6562
```azurecli-interactive
66-
curl --url "https://nameOfFhirAccount.azurehealthcareapis.com/fhir/metadata"
63+
curl --url "https://nameoffhiraccount.azurehealthcareapis.com/metadata"
6764
```
6865

6966
## Clean up resources

‎articles/healthcare-apis/fhir-paas-powershell-quickstart.md

Lines changed: 10 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ author: hansenms
66
ms.service: healthcare-apis
77
ms.subservice: fhir
88
ms.topic: quickstart
9-
ms.date: 02/07/2019
9+
ms.date: 10/15/2019
1010
ms.author: mihansen
1111
---
1212

@@ -28,23 +28,9 @@ If the `Microsoft.HealthcareApis` resource provider is not already registered fo
2828
Register-AzResourceProvider -ProviderNamespace Microsoft.HealthcareApis
2929
```
3030

31-
## Create Azure Resource Manager template
31+
## Locate your identity object ID
3232

33-
Create an Azure Resource Manager template with the following content:
34-
35-
[!code-json[](samples/azuredeploy.json)]
36-
37-
Save it with the name `azuredeploy.json`
38-
39-
## Create Azure Resource Manager parameter file
40-
41-
Create an Azure Resource Manager template parameter file with the following content:
42-
43-
[!code-json[](samples/azuredeploy.parameters.json)]
44-
45-
Save it with the name `azuredeploy.parameters.json`
46-
47-
The object ID values `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` and `yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy` correspond to the object IDs of specific Azure Active Directory users or service principals in the directory associated with the subscription. If you would like to know the object ID of a specific user, you can find it with a command like:
33+
Object ID values are guids that correspond to the object IDs of specific Azure Active Directory users or service principals in the directory associated with the subscription. If you would like to know the object ID of a specific user, you can find it with a command like:
4834

4935
```azurepowershell-interactive
5036
$(Get-AzureADUser -Filter "UserPrincipalName eq '[email protected]'").ObjectId
@@ -55,21 +41,23 @@ Read the how-to guide on [finding identity object IDs](find-identity-object-ids.
5541
## Create Azure resource group
5642

5743
```azurepowershell-interactive
58-
$rg = New-AzResourceGroup -Name "myResourceGroupName" -Location westus2
44+
New-AzResourceGroup -Name "myResourceGroupName" -Location westus2
5945
```
6046

61-
## Deploy template
47+
## Deploy Azure API for FHIR
6248

6349
```azurepowershell-interactive
64-
New-AzResourceGroupDeployment -ResourceGroup $rg.ResourceGroupName -TemplateFile azuredeploy.json -TemplateParameterFile azuredeploy.parameters.json
50+
New-AzHealthcareApisService -Name nameoffhirservice -ResourceGroupName myResourceGroupName -Location westus2 -Kind fhir-R4 -AccessPolicyObjectId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
6551
```
6652

53+
where `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` is the identity object ID for a user or service principal that you would like to have access to the FHIR API.
54+
6755
## Fetch capability statement
6856

6957
You'll be able to validate that the Azure API for FHIR account is running by fetching a FHIR capability statement:
7058

7159
```azurepowershell-interactive
72-
$metadata = Invoke-WebRequest -Uri $metadataUrl "https://nameOfFhirAccount.azurehealthcareapis.com/metadata"
60+
$metadata = Invoke-WebRequest -Uri "https://nameoffhirservice.azurehealthcareapis.com/metadata"
7361
$metadata.RawContent
7462
```
7563

@@ -78,7 +66,7 @@ $metadata.RawContent
7866
If you're not going to continue to use this application, delete the resource group with the following steps:
7967

8068
```azurepowershell-interactive
81-
Remove-AzResourceGroup -Name $rg.ResourceGroupName
69+
Remove-AzResourceGroup -Name myResourceGroupName
8270
```
8371

8472
## Next steps

‎articles/healthcare-apis/index.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
### YamlMime:YamlDocument
22
documentType: LandingData
3-
title: Azure API for FHIR Preview Documentation
3+
title: Azure API for FHIR Documentation
44
metadata:
5-
title: Azure API for FHIR Preview Documentation
5+
title: Azure API for FHIR Documentation
66
meta.description: Learn how Azure API for FHIR can power healthcare iteroperability in Azure.
77
services: healthcare-apis
88
author: hansenms
@@ -13,7 +13,7 @@ metadata:
1313
ms.topic: landing-page
1414
ms.date: 02/07/2019
1515
abstract:
16-
description: Azure API for FHIR® Preview is a fully managed, standards-based, compliant API for clinical health data that enables you to create new systems of engagement for analytics, machine learning, and actionable intelligence with your health data.
16+
description: Azure API for FHIR® is a fully managed, standards-based, compliant API for clinical health data that enables you to create new systems of engagement for analytics, machine learning, and actionable intelligence with your health data.
1717
sections:
1818
- title:
1919
items:
@@ -22,7 +22,7 @@ sections:
2222
- title: 5-Minute Quickstarts
2323
items:
2424
- type: paragraph
25-
text: Learn how Azure API for FHIR Preview can power healthcare interoperability in Azure by selecting an arrow link <img src="media/index/link.jpg" height="15" width="15"></img>.
25+
text: Learn how Azure API for FHIR can power healthcare interoperability in Azure by selecting an arrow link <img src="media/index/link.jpg" height="15" width="15"></img>.
2626
- type: table
2727
style: dataMatrix
2828
columns:

‎articles/healthcare-apis/media/custom-headers/custom-headers-diagram.png

223 KB
Loading

‎articles/healthcare-apis/media/tutorial-0/flow-azure-api-for-fhir.png

87.8 KB
Loading

‎articles/healthcare-apis/media/tutorial-0/flow-fhir-server-azure.png

43.7 KB
Loading

‎articles/healthcare-apis/overview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: What is Azure API for FHIR Preview - Azure API for FHIR Preview
2+
title: What is Azure API for FHIR - Azure API for FHIR
33
description: This article describes Azure API for FHIR.
44
services: healthcare-apis
55
author: hansenms
@@ -10,7 +10,7 @@ ms.date: 02/07/2019
1010
ms.author: mihansen
1111
---
1212

13-
# What is Azure API for FHIR&reg; Preview?
13+
# What is Azure API for FHIR&reg;?
1414
Azure API for FHIR enables rapid exchange of data through FHIR APIs, backed by a managed Platform-as-a Service (PaaS) offering in the cloud. It makes it easier for anyone working with health data to ingest, manage, and persist Protected Health Information [PHI](https://www.hhs.gov/answers/hipaa/what-is-phi/index.html) in the cloud:
1515

1616
- Managed FHIR service, provisioned in the cloud in minutes

0 commit comments

Comments
 (0)