Skip to content

Commit 0ee7c2e

Browse files
authored
Merge pull request #273368 from JanSchietse/RIDoc-GA-pr
Ri doc ga pr
2 parents 11ff556 + 2e974a2 commit 0ee7c2e

19 files changed

+1590
-948
lines changed
Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
---
2+
title: "Quickstart: Create and deploy an Azure HealthInsights resource using CLI"
3+
description: "This document explains how to create and deploy an Azure HealthInsights resource using CLI"
4+
author: hvanhoe
5+
ms.author: henkvanhoe
6+
ms.service: azure-health-insights
7+
ms.topic: quickstart #Don't change
8+
ms.date: 04/09/2024
9+
---
10+
11+
# Quickstart: Create and deploy an Azure AI Health Insights resource (CLI)
12+
13+
This quickstart provides step-by-step instructions to create a resource and deploy a model. You can create resources in Azure in several different ways:
14+
15+
- The [Azure portal](https://portal.azure.com/)
16+
- The REST APIs, the Azure CLI, PowerShell, or client libraries
17+
- Azure Resource Manager (ARM) templates
18+
19+
In this article, you review examples for creating and deploying resources with the Azure CLI.
20+
21+
## Prerequisites
22+
23+
- An Azure subscription.
24+
- The Azure CLI. For more information, see [How to install the Azure CLI](/cli/azure/install-azure-cli).
25+
26+
## Sign in to the Azure CLI
27+
28+
[Sign in](/cli/azure/authenticate-azure-cli) to the Azure CLI or select **Open Cloudshell** in the following steps.
29+
30+
## Create an Azure resource group
31+
32+
To create an Azure Health Insights resource, you need an Azure resource group. When you create a new resource through the Azure CLI, you can also create a new resource group or instruct Azure to use an existing group. The following example shows how to create a new resource group named _HealthInsightsResourceGroup_ with the [az group create](/cli/azure/group?view=azure-cli-latest&preserve-view=true#az-group-create) command. The resource group is created in the East US location.
33+
34+
```azurecli
35+
az group create \
36+
--name HealthInsightsResourceGroup \
37+
--location eastus
38+
```
39+
40+
## Create a resource
41+
42+
Use the [az cognitiveservices account create](/cli/azure/cognitiveservices/account?view=azure-cli-latest&preserve-view=true#az-cognitiveservices-account-create) command to create an Azure Health Insights resource in the resource group. In the following example, you create a resource named _HealthInsightsResource_ in the _HealthInsightsResourceGroup_ resource group. When you try the example, update the code to use your desired values for the resource group and resource name, along with your Azure subscription ID.
43+
44+
```azurecli
45+
az cognitiveservices account create \
46+
--name HealthInsightsResource \
47+
--resource-group HealthInsightsResourceGroup \
48+
--kind HealthInsights \
49+
--sku F0 \
50+
--location eastus \
51+
--custom-domain healthinsightsresource \
52+
--subscription <subscriptionID>
53+
```
54+
55+
## Retrieve information about the resource
56+
57+
After you create the resource, you can use different commands to find useful information about your Azure Health Insights instance. The following examples demonstrate how to retrieve the REST API endpoint base URL and the access keys for the new resource.
58+
59+
### Get the endpoint URL
60+
61+
Use the [az cognitiveservices account show](/cli/azure/cognitiveservices/account?view=azure-cli-latest&preserve-view=true#az-cognitiveservices-account-show) command to retrieve the REST API endpoint base URL for the resource. In this example, we direct the command output through the [jq](https://jqlang.github.io/jq/) JSON processor to locate the `.properties.endpoint` value.
62+
63+
When you try the example, update the code to use your values for the resource group and resource.
64+
65+
```azurecli
66+
az cognitiveservices account show \
67+
--name HealthInsightsResource \
68+
--resource-group HealthInsightsResourceGroup \
69+
| jq -r .properties.endpoint
70+
```
71+
72+
### Get the primary API key
73+
74+
To retrieve the access keys for the resource, use the [az cognitiveservices account keys list](/cli/azure/cognitiveservices/account?view=azure-cli-latest&preserve-view=true#az-cognitiveservices-account-keys-list) command. In this example, we direct the command output through the [jq](https://jqlang.github.io/jq/) JSON processor to locate the `.key1` value.
75+
76+
When you try the example, update the code to use your values for the resource group and resource.
77+
78+
```azurecli
79+
az cognitiveservices account keys list \
80+
--name HealthInsightsResource \
81+
--resource-group HealthInsightsResourceGroup \
82+
| jq -r .key1
83+
```
84+
85+
## Delete a resource or resource group
86+
87+
If you want to clean up after these exercises, you can remove your Azure Health Insights resource by deleting the resource through the Azure CLI.
88+
89+
To remove the resource, use the [az cognitiveservices account delete](/cli/azure/cognitiveservices/account/deployment?view=azure-cli-latest&preserve-view=true#az-cognitiveservices-account-delete) command. When you run this command, be sure to update the example code to use your values for the resource group and resource.
90+
91+
```azurecli
92+
az cognitiveservices account delete \
93+
--name HealthInsightsResource \
94+
--resource-group HealthInsightsResourceGroup
95+
```
96+
97+
You can also delete the resource group. If you choose to delete the resource group, all resources contained in the group are also deleted. When you run this command, be sure to update the example code to use your values for the resource group.
98+
99+
```azurecli
100+
az group delete \
101+
--name HealthInsightsResourceGroup
102+
```
103+
104+
105+
## Next steps
106+
107+
<!--- Access Radiology Insights with the [REST API](get-started.md). --->
Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
---
2+
title: "Quickstart: Create and deploy an Azure AI Health Insights resource using PowerShell"
3+
description: "This document explains how to create and deploy an Azure AI Health Insights resource using PowerShell"
4+
author: hvanhoe
5+
ms.author: henkvanhoe
6+
ms.service: azure-health-insights
7+
ms.topic: quickstart #Don't change
8+
ms.date: 04/09/2024
9+
---
10+
11+
# Quickstart: Create and deploy an Azure AI Health Insights resource (PowerShell)
12+
13+
This quickstart provides step-by-step instructions to create a resource and deploy a model. You can create resources in Azure in several different ways:
14+
15+
- The [Azure portal](https://portal.azure.com/)
16+
- The REST APIs, the Azure CLI, PowerShell, or client libraries
17+
- Azure Resource Manager (ARM) templates
18+
19+
In this article, you review examples for creating and deploying resources with PowerShell.
20+
21+
## Prerequisites
22+
23+
- An Azure subscription.
24+
- The Azure CLI. For more information, see [How to install the Azure CLI](/cli/azure/install-azure-cli).
25+
26+
## Sign in to the Azure PowerShell
27+
28+
[Sign in](/powershell/azure/authenticate-azureps) to the Azure CLI or select **Open Cloud Shell** in the following steps.
29+
30+
## Create an Azure resource group
31+
32+
To create an Azure Health Insights resource, you need an Azure resource group. When you create a new resource through Azure PowerShell, you can also create a new resource group or instruct Azure to use an existing group. The following example shows how to create a new resource group named _HealthInsightsResourceGroup_ with the [New-AzResourceGroup](/powershell/module/az.resources/new-azresourcegroup) command. The resource group is created in the East US location.
33+
34+
```azurepowershell-interactive
35+
New-AzResourceGroup -Name HealthInsightsResourceGroup -Location eastus
36+
```
37+
38+
## Create a resource
39+
40+
Use the [New-AzCognitiveServicesAccount](/powershell/module/az.cognitiveservices/new-azcognitiveservicesaccount) command to create an Azure Health Insights resource in the resource group. In the following example, you create a resource named _HealthInsightsResource_ in the _HealthInsightsResourceGroup_ resource group. When you try the example, update the code to use your desired values for the resource group and resource name, along with your Azure subscription ID.
41+
42+
```azurepowershell-interactive
43+
New-AzCognitiveServicesAccount -ResourceGroupName HealthInsightsResourceGroup -Name HealthInsightsResource -Type HealthInsights -SkuName F0 -Location eastus -CustomSubdomainName healthinsightsresource
44+
```
45+
46+
## Retrieve information about the resource
47+
48+
After you create the resource, you can use different commands to find useful information about your Azure Health Insights Service instance. The following examples demonstrate how to retrieve the REST API endpoint base URL and the access keys for the new resource.
49+
50+
### Get the endpoint URL
51+
52+
Use the [Get-AzCognitiveServicesAccount](/powershell/module/az.cognitiveservices/get-azcognitiveservicesaccount) command to retrieve the REST API endpoint base URL for the resource. In this example, we direct the command output through the [Select-Object](/powershell/module/microsoft.powershell.utility/select-object) cmdlet to locate the `endpoint` value.
53+
54+
When you try the example, update the code to use your values for the resource group and resource.
55+
56+
```azurepowershell-interactive
57+
Get-AzCognitiveServicesAccount -ResourceGroupName HealthInsightsResourceGroup -Name HealthInsightsResource |
58+
Select-Object -Property endpoint
59+
```
60+
61+
### Get the primary API key
62+
63+
To retrieve the access keys for the resource, use the [Get-AzCognitiveServicesAccountKey](/powershell/module/az.cognitiveservices/get-azcognitiveservicesaccountkey) command. In this example, we direct the command output through the [Select-Object](/powershell/module/microsoft.powershell.utility/select-object) cmdlet to locate the `Key1` value.
64+
65+
When you try the example, update the code to use your values for the resource group and resource.
66+
67+
```azurepowershell-interactive
68+
Get-AzCognitiveServicesAccountKey -Name HealthInsightsResource -ResourceGroupName HealthInsightsResourceGroup |
69+
Select-Object -Property Key1
70+
```
71+
72+
## Delete a resource
73+
74+
If you want to clean up after these exercises, you can remove your Azure Health Insights resource by deleting the resource through the Azure PowerShell.
75+
76+
To remove the resource, use the [Remove-AzCognitiveServicesAccount](/powershell/module/az.cognitiveservices/remove-azcognitiveservicesaccount) command. When you run this command, be sure to update the example code to use your values for the resource group and resource.
77+
78+
```azurepowershell-interactive
79+
Remove-AzCognitiveServicesAccount -Name HealthInsightsResource -ResourceGroupName HealthInsightsResourceGroup
80+
```
81+
82+
You can also delete the resource group. If you choose to delete the resource group, all resources contained in the group are also deleted. When you run this command, be sure to update the example code to use your values for the resource group.
83+
84+
```azurepowershell-interactive
85+
Remove-AzResourceGroup -Name HealthInsightsResourceGroup
86+
```
87+
88+
89+
## Next steps
90+
91+
<!--- - Access Radiology Insights with the [REST API](get-started.md). --->

articles/azure-health-insights/includes/example-1-inference-follow-up-recommendation-json-request.md

Lines changed: 89 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -9,76 +9,95 @@ ms.service: azure-health-insights
99

1010
```json
1111
{
12-
"configuration" : {
13-
"inferenceOptions" : {
14-
"followupRecommendationOptions" : {
15-
"includeRecommendationsWithNoSpecifiedModality" : true,
16-
"includeRecommendationsInReferences" : false,
17-
"provideFocusedSentenceEvidence" : false
18-
},
19-
"findingOptions" : {
20-
"provideFocusedSentenceEvidence" : true
21-
}
22-
},
23-
"inferenceTypes" : [ "finding", "followupRecommendation" ],
24-
"locale" : "en-US",
25-
"verbose" : false,
26-
"includeEvidence" : true
27-
},
28-
"patients" : [ {
29-
"id" : "11111",
30-
"info" : {
31-
"sex" : "male",
32-
"clinicalInfo" : [ {
33-
"resourceType" : "Observation",
34-
"status" : "unknown",
35-
"code" : {
36-
"coding" : [ {
37-
"system" : "http://www.nlm.nih.gov/research/umls",
38-
"code" : "C0018802",
39-
"display" : "MalignantNeoplasms"
40-
} ]
41-
},
42-
"valueBoolean" : "true"
43-
} ]
44-
},
45-
"encounters" : [ {
46-
"id" : "encounterid1",
47-
"period" : {
48-
"start" : "2014-2-20T00:00:00",
49-
"end" : "2014-2-20T00:00:00"
50-
},
51-
"class" : "inpatient"
52-
} ],
53-
"patientDocuments" : [ {
54-
"type" : "note",
55-
"clinicalType" : "radiologyReport",
56-
"id" : "docid1",
57-
"language" : "en",
58-
"authors" : [ {
59-
"id" : "authorid1",
60-
"name" : "authorname1"
61-
} ],
62-
"specialtyType" : "radiology",
63-
"createdDateTime" : "2014-2-20T00:00:00",
64-
"administrativeMetadata" : {
65-
"orderedProcedures" : [ {
66-
"code" : {
67-
"coding" : [ {
68-
"system" : "Https://loinc.org",
69-
"code" : "LP207608-3",
70-
"display" : "ULTRASOUND"
71-
} ]
12+
"jobData": {
13+
"configuration": {
14+
"inferenceOptions": {
15+
"followupRecommendationOptions": {
16+
"includeRecommendationsWithNoSpecifiedModality": true,
17+
"includeRecommendationsInReferences": false,
18+
"provideFocusedSentenceEvidence": false
19+
},
20+
"findingOptions": {
21+
"provideFocusedSentenceEvidence": true
22+
}
7223
},
73-
"description" : "ULTRASOUND"
74-
} ],
75-
"encounterId" : "encounterid1"
76-
},
77-
"content" : {
78-
"sourceType" : "inline",
79-
"value" : " \n\nIMPRESSION: \n \n1. Given its size, surgical \nconsultation is recommended.\n2. Recommend ultrasound.\n3. Recommend screening.\n\nRECOMMENDATION:\n\nTHIS IS A (AAA) CASE. An aneurysm follow up program has been developed to facilitate the monitoring of your patient and the next ultrasound will be arranged based on approved guidelines. \nKP NW Practice Guidelines for Surveillance of a AAA: Recommended Imaging Intervals \n<3cm No need for followup \n3-3.9cm Every 3 years \n4-4.4cm Every 2 years \n4.5-4.9cm Female every 6 months, Male every year \n5.0-5.5cm Male every 6 months \nReferral to Vascular Surgery: \nFemale >5cm \nMale <60 years of age; >5cm \nMale >61 years of age; >5.5cm.\nIf infrarenal aorta not well seen on US, repeat in 1 month with 24 hour liquid diet. If still not well seen, CT non-contrast abd/pelvis.\n"
24+
"inferenceTypes": ["finding", "followupRecommendation"],
25+
"locale": "en-US",
26+
"verbose": false,
27+
"includeEvidence": true
28+
},
29+
"patients": [
30+
{
31+
"id": "111111",
32+
"details": {
33+
"sex": "female",
34+
"birthDate" : "2011-08-31T18:00:00+00:00",
35+
"clinicalInfo": [
36+
{
37+
"resourceType": "Observation",
38+
"status": "unknown",
39+
"code": {
40+
"coding": [
41+
{
42+
"system": "http://www.nlm.nih.gov/research/umls",
43+
"code": "C0018802",
44+
"display": "MalignantNeoplasms"
45+
}
46+
]
47+
},
48+
"valueBoolean": "true"
49+
}
50+
]
51+
},
52+
"encounters": [
53+
{
54+
"id": "encounterid1",
55+
"period": {
56+
"start": "2014-2-20T00:00:00",
57+
"end": "2014-2-20T00:00:00"
58+
},
59+
"class": "inpatient"
60+
}
61+
],
62+
"patientDocuments": [
63+
{
64+
"type": "note",
65+
"clinicalType": "radiologyReport",
66+
"id": "docid1",
67+
"language": "en",
68+
"authors": [
69+
{
70+
"id": "authorid1",
71+
"fullName": "authorname1"
72+
}
73+
],
74+
"specialtyType": "radiology",
75+
"createdAt": "2014-2-20T00:00:00",
76+
"administrativeMetadata": {
77+
"orderedProcedures": [
78+
{
79+
"code": {
80+
"coding": [
81+
{
82+
"system": "Https://loinc.org",
83+
"code": "LP207608-3",
84+
"display": "ULTRASOUND"
85+
}
86+
]
87+
},
88+
"description": "ULTRASOUND"
89+
}
90+
],
91+
"encounterId": "encounterid1"
92+
},
93+
"content": {
94+
"sourceType": "inline",
95+
"value" : " \n\nIMPRESSION: \n \n1. Given its size, surgical \nconsultation is recommended.\n2. Recommend ultrasound.\n3. Recommend screening.\n\nRECOMMENDATION:\n\nTHIS IS A (AAA) CASE. An aneurysm follow up program has been developed to facilitate the monitoring of your patient and the next ultrasound will be arranged based on approved guidelines. \nKP NW Practice Guidelines for Surveillance of a AAA: Recommended Imaging Intervals \n<3cm No need for followup \n3-3.9cm Every 3 years \n4-4.4cm Every 2 years \n4.5-4.9cm Female every 6 months, Male every year \n5.0-5.5cm Male every 6 months \nReferral to Vascular Surgery: \nFemale >5cm \nMale <60 years of age; >5cm \nMale >61 years of age; >5.5cm.\nIf infrarenal aorta not well seen on US, repeat in 1 month with 24 hour liquid diet. If still not well seen, CT non-contrast abd/pelvis.\n"
96+
}
97+
}
98+
]
99+
}
100+
]
80101
}
81-
} ]
82-
} ]
83-
}
102+
}
84103
```

0 commit comments

Comments
 (0)