Skip to content

Commit 217c97f

Browse files
authored
Merge pull request #286500 from KendalBond007/FHIReditsBatch10_Sep24
FHIReditsBatch10_Sep24
2 parents 04db7b7 + 42d9285 commit 217c97f

File tree

6 files changed

+97
-96
lines changed

6 files changed

+97
-96
lines changed

articles/healthcare-apis/fhir/fhir-service-resource-manager-template.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ ms.date: 06/06/2022
1111

1212
# Deploy a FHIR service within Azure Health Data Services - using ARM template
1313

14-
In this article, you'll learn how to deploy FHIR service within the Azure Health Data Services (hereby called FHIR service) using the Azure Resource Manager template (ARM template). We provide you two options using PowerShell or using CLI.
14+
In this article, you'll learn how to deploy FHIR® service within the Azure Health Data Services using the Azure Resource Manager template (ARM template). We provide two options: using PowerShell or using CLI.
1515

1616
An [ARM template](../../azure-resource-manager/templates/overview.md) is a JSON file that defines the infrastructure and configuration for your project. The template uses declarative syntax. In declarative syntax, you describe your intended deployment without writing the sequence of programming commands to create the deployment.
1717

@@ -38,11 +38,11 @@ The template used in this article is from [Azure Quickstart Templates](https://a
3838

3939
The template defines three Azure resources:
4040
- Microsoft.HealthcareApis/workspaces
41-
- Microsoft.HealthcareApis/workspaces/fhirservices
41+
- Microsoft.HealthcareApis/workspaces/fhirservices
4242
- Microsoft.Storage/storageAccounts
4343

4444
> [!NOTE]
45-
> Local RBAC is deprecated. Access Policies configuration associated with Local RBAC in ARM template are deprecated. Existing customers using Local RBAC need to migrate to Azure RBAC by November 2024. For questions, please [contact us](https://portal.azure.com/#blade/Microsoft_Azure_Support/HelpAndSupportBlade/overview).
45+
> Local RBAC is deprecated. Access Policies configuration associated with Local RBAC in ARM templates are deprecated. Existing customers using Local RBAC need to migrate to Azure RBAC by November 2024. For questions, please [contact us](https://portal.azure.com/#blade/Microsoft_Azure_Support/HelpAndSupportBlade/overview).
4646
4747
You can deploy the FHIR service resource by **removing** the workspaces resource, the storage resource, and the `dependsOn` property in the “Microsoft.HealthcareApis/workspaces/fhirservices” resource.
4848

@@ -186,19 +186,19 @@ You can deploy the FHIR service resource by **removing** the workspaces resource
186186

187187
You can deploy the ARM template using two options: PowerShell or CLI.
188188

189-
The sample code provided below uses the template in the “templates” subfolder of the subfolder “src”. You may want to change the location path to reference the template file properly.
189+
The following sample code uses the template in the “templates” subfolder of the subfolder “src”. You may want to change the location path to reference the template file properly.
190190

191-
The deployment process takes a few minutes to complete. Take a note of the names for the FHIR service and the resource group, which you'll use later.
191+
The deployment process takes a few minutes to complete. Take a note of the names for the FHIR service and the resource group, which you use later.
192192

193193
# [PowerShell](#tab/PowerShell)
194194

195195
### Deploy the template: using PowerShell
196196

197-
Run the code in PowerShell locally, in Visual Studio Code, or in Azure Cloud Shell, to deploy the FHIR service.
197+
To deploy the FHIR service, run the code in PowerShell locally, in Visual Studio Code, or in Azure Cloud Shell.
198198

199199
If you haven't logged in to Azure, use "Connect-AzAccount" to log in. Once you've logged in, use "Get-AzContext" to verify the subscription and tenant you want to use. You can change the subscription and tenant if needed.
200200

201-
You can create a new resource group, or use an existing one by skipping the step or commenting out the line starting with “New-AzResourceGroup”.
201+
You can create a new resource group, or use an existing one by skipping the step, or commenting out the line starting with “New-AzResourceGroup”.
202202

203203
```powershell-interactive
204204
### variables
@@ -228,11 +228,11 @@ New-AzResourceGroupDeployment -ResourceGroupName $resourcegroupname -TemplateFil
228228

229229
### Deploy the template: using CLI
230230

231-
Run the code locally, in Visual Studio Code or in Azure Cloud Shell, to deploy the FHIR service.
231+
To deploy the FHIR service, run the code in PowerShell locally, in Visual Studio Code, or in Azure Cloud Shell.
232232

233233
If you haven’t logged in to Azure, use "az login" to log in. Once you've logged in, use "az account show --output table" to verify the subscription and tenant you want to use. You can change the subscription and tenant if needed.
234234

235-
You can create a new resource group, or use an existing one by skipping the step or commenting out the line starting with "az group create".
235+
You can create a new resource group, or use an existing one by skipping the step, or commenting out the line starting with "az group create".
236236

237237
```azurecli-interactive
238238
### variables
@@ -261,11 +261,11 @@ az deployment group create --resource-group $resourcegroupname --template-file '
261261

262262
## Review the deployed resources
263263

264-
You can verify that the FHIR service is up and running by opening the browser and navigating to `https://<yourfhir servic>.azurehealthcareapis.com/metadata`. If the capability statement is displayed or downloaded automatically, your deployment is successful.
264+
You can verify that the FHIR service is up and running by opening a browser and navigating to `https://<yourfhir servic>.azurehealthcareapis.com/metadata`. If the capability statement is displayed or downloaded automatically, your deployment is successful.
265265

266266
## Clean up the resources
267267

268-
When the resource is no longer needed, run the code below to delete the resource group.
268+
When the resource is no longer needed, run the following code to delete the resource group.
269269

270270
# [PowerShell](#tab/PowerShell)
271271
```powershell-interactive
@@ -286,4 +286,4 @@ In this quickstart guide, you've deployed the FHIR service within Azure Health D
286286
>[!div class="nextstepaction"]
287287
>[Supported FHIR Features](fhir-features-supported.md)
288288
289-
FHIR&#174; is a registered trademark of [HL7](https://hl7.org/fhir/) and is used with the permission of HL7.
289+
[!INCLUDE [FHIR trademark statement](../includes/healthcare-apis-fhir-trademark.md)]

articles/healthcare-apis/fhir/fhir-versioning-policy-and-history-management.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -11,25 +11,25 @@ ms.author: kesheth
1111

1212
# Versioning policy and history management
1313

14-
The versioning policy in the Azure Health Data Services FHIR service is a configuration, which determines how history is stored for every resource type with the option for resource specific configuration. This policy is directly related to the concept of managing history for FHIR resources.
14+
The versioning policy in the Azure Health Data Services FHIR&reg; service is a configuration which determines how history is stored for every resource type, with the option for resource specific configuration. This policy is directly related to the concept of managing history for FHIR resources.
1515

1616
## History in FHIR
1717

18-
History in FHIR gives you the ability to see all previous versions of a resource. History in FHIR can be queried at the resource level, type level, or system level. The HL7 FHIR documentation has more information about the [history interaction](https://www.hl7.org/fhir/http.html#history). History is useful in scenarios where you want to see the evolution of a resource in FHIR or if you want to see the information of a resource at a specific point in time.
18+
History in FHIR gives you the ability to see all previous versions of a resource. History in FHIR can be queried at the resource level, type level, or system level. The HL7 FHIR documentation has more information about the [history interaction](https://www.hl7.org/fhir/http.html#history). History is useful when you want to see the evolution of a resource in FHIR, or if you want to see a resource's information at a specific point in time.
1919

20-
All past versions of a resource are considered obsolete and the current version of a resource should be used for normal business workflow operations. However, it can be useful to see the state of a resource as a point in time when a past decision was made.
20+
All past versions of a resource are considered obsolete, and the current version of a resource should be used for normal business workflow operations. However, it can be useful to see the state of a resource as a point in time when a past decision was made.
2121

2222
## Versioning policy
2323

24-
Versioning policy in the FHIR service lets you decide how history is stored either at a FHIR service level or at a specific resource level.
24+
Versioning policy in the FHIR service lets you decide how history is stored, either at a FHIR service level or at a specific resource level.
2525

2626
There are three different levels for versioning policy:
2727

2828
- `versioned`: History is stored for operation on resources. Resource version is incremented. This is the default.
2929
- `version-update`: History is stored for operation on resources. Resource version is incremented. Updates require a valid `If-Match` header. For more information, see [VersionedUpdateExample.http](https://github.com/microsoft/fhir-server/blob/main/docs/rest/VersionedUpdateExample.http).
3030
- `no-version`: History isn't created for resources. Resource version is incremented.
3131

32-
Versioning policy available to configure at as a system-wide setting and also to override at a resource level. The system-wide setting is used for all resources in your FHIR service, unless a specific resource level versioning policy has been added.
32+
Versioning policy is available to configure as a system-wide setting, and also to override at a resource level. The system-wide setting is used for all resources in your FHIR service, unless a specific resource level versioning policy has been added.
3333

3434
### Versioning policy comparison
3535

@@ -44,15 +44,15 @@ Versioning policy available to configure at as a system-wide setting and also to
4444
4545
## Configuring versioning policy
4646

47-
To configure versioning policy, select the **Versioning Policy Configuration** blade inside your FHIR service.
47+
To configure versioning policy, select **Versioning Policy Configuration** inside your FHIR service.
4848

4949
:::image type="content" source="media/versioning-policy/fhir-service-versioning-policy-configuration.png" alt-text="Screenshot of the Azure portal Versioning Policy Configuration." lightbox="media/versioning-policy/fhir-service-versioning-policy-configuration.png":::
5050

51-
After you've browsed to Versioning Policy Configuration, you'll be able to configure the setting at both system level and the resource level (as an override of the system level). The system level configuration (annotated as 1) will apply to every resource in your FHIR service unless a resource specific override (annotated at 2) has been configured.
51+
After you've browsed to Versioning Policy Configuration, you'll be able to configure the setting at both system level and the resource level (as an override of the system level). The system level configuration (annotated as 1) applies to every resource in your FHIR service unless a resource specific override (annotated as 2) has been configured.
5252

5353
:::image type="content" source="media/versioning-policy/system-level-versus-resource-level.png" alt-text="Screenshot of Azure portal versioning policy configuration showing system level vs resource level configuration." lightbox="media/versioning-policy/system-level-versus-resource-level.png":::
5454

55-
When configuring resource level configuration, you'll be able to select the FHIR resource type (annotated as 1) and the specific versioning policy for this specific resource (annotated as 2). Make sure to select the **Add** button (annotated as 3) to queue up this setting for saving.
55+
When configuring resource level configuration, you're able to select the FHIR resource type (annotated as 1) and the specific versioning policy for this specific resource (annotated as 2). Make sure to select the **Add** button (annotated as 3) to queue up this setting for saving.
5656

5757
:::image type="content" source="media/versioning-policy/resource-versioning.jpg" alt-text="Screenshot of Azure portal versioning policy configuration showing resource level configuration." lightbox="media/versioning-policy/resource-versioning.jpg":::
5858

@@ -62,12 +62,12 @@ When configuring resource level configuration, you'll be able to select the FHIR
6262

6363
## History management
6464

65-
History in FHIR is important for end users to see how a resource has changed over time. It's also useful in coordination with audit logs to see the state of a resource before and after a user modified it. In general, it's recommended to keep history for a resource unless you know that the history isn't needed. Frequent updates of resources can result in a large amount of data storage, which can be undesired in FHIR services with a large amount of data.
65+
History in FHIR is important for end users to see how a resource has changed over time. It's also useful in coordination with audit logs to see the state of a resource before and after a user modified it. In general, it's recommended to keep history for a resource unless you know that the history isn't needed. Frequent resource updates can result in a large amount of data storage, which can be undesirable in FHIR services with a large amount of data.
6666

67-
Changing the versioning policy either at a system level or resource level won't remove the existing history for any resources in your FHIR service. If you're looking to reduce the history data size in your FHIR service, you must use the [$purge-history](purge-history.md) operation.
67+
Changing the versioning policy, either at a system level or resource level, won't remove the existing history for any resources in your FHIR service. If you're looking to reduce the history data size in your FHIR service, you must use the [$purge-history](purge-history.md) operation.
6868

6969
> [!NOTE]
70-
> The query parameter _summary=count and _count=0 can be added to _history endpoint to get count of all versioned resources. This count includes soft deleted resources.
70+
> The query parameter _summary=count and _count=0 can be added to _history endpoint to get a count of all versioned resources. This count includes soft deleted resources.
7171
7272
## Next steps
7373

@@ -76,5 +76,4 @@ In this article, you learned how to purge the history for resources in the FHIR
7676
>[!div class="nextstepaction"]
7777
>[Purge history operation](purge-history.md)
7878
79-
FHIR&#174; is a registered trademark of [HL7](https://hl7.org/fhir/) and is used with the permission of HL7.
80-
79+
[!INCLUDE [FHIR trademark statement](../includes/healthcare-apis-fhir-trademark.md)]

articles/healthcare-apis/fhir/get-started-with-fhir.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ As a prerequisite, you need an Azure subscription and permissions to create Azur
2020

2121
## Create a workspace in your Azure subscription
2222

23-
You can create a workspace from the [Azure portal](../healthcare-apis-quickstart.md), or using PowerShell, Azure CLI, and REST API. You can find scripts from the [Azure Health Data Services samples](https://github.com/microsoft/healthcare-apis-samples/tree/main/src/scripts).
23+
Create a workspace from the [Azure portal](../healthcare-apis-quickstart.md), or using PowerShell, Azure CLI, and REST API. You can find scripts from the [Azure Health Data Services samples](https://github.com/microsoft/healthcare-apis-samples/tree/main/src/scripts).
2424

2525
> [!NOTE]
2626
> There are limits to the number of workspaces and the number of FHIR service instances you can create in each Azure subscription.
@@ -33,7 +33,7 @@ Optionally, you can create a [DICOM service](../dicom/deploy-dicom-services-in-a
3333

3434
## Access the FHIR service
3535

36-
The FHIR service is secured by Microsoft Entra ID that can't be disabled. To access the service API, you must create a client application also referred to as a service principal in Microsoft Entra ID and grant it with the right permissions.
36+
The FHIR service is secured by Microsoft Entra ID that can't be disabled. To access the service API, you must create a client application (also referred to as a service principal) in Microsoft Entra ID, and grant it the right permissions.
3737

3838
### Register a client application
3939

@@ -49,7 +49,7 @@ You can grant access permissions or assign roles in the [Azure portal](../config
4949

5050
### Perform create, read, update, and delete (CRUD) transactions
5151

52-
You can perform Create, Read (search), Update, and Delete (CRUD) transactions against the FHIR service in your applications or by using tools such as Postman, REST Client, and cURL. Because the FHIR service is secured by default, you need to obtain an access token and include it in your transaction request.
52+
You can perform Create, Read (search), Update, and Delete - CRUD - transactions against the FHIR service in your applications or by using tools such as Postman, REST Client, and cURL. Because the FHIR service is secured by default, you need to obtain an access token and include it in your transaction request.
5353

5454
#### Get an access token
5555

@@ -71,7 +71,7 @@ You can find more details on interoperability and patient access, search, profil
7171

7272
### Export data
7373

74-
Optionally, you can export ($export) data to [Azure Storage](../data-transformation/export-data.md) and use it in your analytics or machine-learning projects. You can export the data "as-is" or [deID](../data-transformation/de-identified-export.md) in `ndjson` format.
74+
Optionally, you can export ($export) data to [Azure Storage](../data-transformation/export-data.md) and use it in your analytics or machine-learning projects. You can export the data "as-is" or [de-identified](../data-transformation/de-identified-export.md) in `ndjson` format.
7575

7676
### Convert data
7777

0 commit comments

Comments
 (0)