You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/healthcare-apis/fhir/fhir-service-resource-manager-template.md
+12-12Lines changed: 12 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ ms.date: 06/06/2022
11
11
12
12
# Deploy a FHIR service within Azure Health Data Services - using ARM template
13
13
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.
15
15
16
16
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.
17
17
@@ -38,11 +38,11 @@ The template used in this article is from [Azure Quickstart Templates](https://a
> 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).
46
46
47
47
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.
48
48
@@ -186,19 +186,19 @@ You can deploy the FHIR service resource by **removing** the workspaces resource
186
186
187
187
You can deploy the ARM template using two options: PowerShell or CLI.
188
188
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.
190
190
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.
192
192
193
193
# [PowerShell](#tab/PowerShell)
194
194
195
195
### Deploy the template: using PowerShell
196
196
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.
198
198
199
199
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.
200
200
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”.
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.
232
232
233
233
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.
234
234
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".
236
236
237
237
```azurecli-interactive
238
238
### variables
@@ -261,11 +261,11 @@ az deployment group create --resource-group $resourcegroupname --template-file '
261
261
262
262
## Review the deployed resources
263
263
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.
265
265
266
266
## Clean up the resources
267
267
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.
269
269
270
270
# [PowerShell](#tab/PowerShell)
271
271
```powershell-interactive
@@ -286,4 +286,4 @@ In this quickstart guide, you've deployed the FHIR service within Azure Health D
Copy file name to clipboardExpand all lines: articles/healthcare-apis/fhir/fhir-versioning-policy-and-history-management.md
+12-13Lines changed: 12 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,25 +11,25 @@ ms.author: kesheth
11
11
12
12
# Versioning policy and history management
13
13
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® 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.
15
15
16
16
## History in FHIR
17
17
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.
19
19
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.
21
21
22
22
## Versioning policy
23
23
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.
25
25
26
26
There are three different levels for versioning policy:
27
27
28
28
-`versioned`: History is stored for operation on resources. Resource version is incremented. This is the default.
29
29
-`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).
30
30
-`no-version`: History isn't created for resources. Resource version is incremented.
31
31
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.
33
33
34
34
### Versioning policy comparison
35
35
@@ -44,15 +44,15 @@ Versioning policy available to configure at as a system-wide setting and also to
44
44
45
45
## Configuring versioning policy
46
46
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.
48
48
49
49
:::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":::
50
50
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.
52
52
53
53
:::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":::
54
54
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.
@@ -62,12 +62,12 @@ When configuring resource level configuration, you'll be able to select the FHIR
62
62
63
63
## History management
64
64
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.
66
66
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.
68
68
69
69
> [!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.
71
71
72
72
## Next steps
73
73
@@ -76,5 +76,4 @@ In this article, you learned how to purge the history for resources in the FHIR
76
76
>[!div class="nextstepaction"]
77
77
>[Purge history operation](purge-history.md)
78
78
79
-
FHIR® is a registered trademark of [HL7](https://hl7.org/fhir/) and is used with the permission of HL7.
Copy file name to clipboardExpand all lines: articles/healthcare-apis/fhir/get-started-with-fhir.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,7 @@ As a prerequisite, you need an Azure subscription and permissions to create Azur
20
20
21
21
## Create a workspace in your Azure subscription
22
22
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).
24
24
25
25
> [!NOTE]
26
26
> 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
33
33
34
34
## Access the FHIR service
35
35
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.
37
37
38
38
### Register a client application
39
39
@@ -49,7 +49,7 @@ You can grant access permissions or assign roles in the [Azure portal](../config
49
49
50
50
### Perform create, read, update, and delete (CRUD) transactions
51
51
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.
53
53
54
54
#### Get an access token
55
55
@@ -71,7 +71,7 @@ You can find more details on interoperability and patient access, search, profil
71
71
72
72
### Export data
73
73
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.
0 commit comments