Merge pull request #262140 from EXPEkesheth/patch-130

Export support history and soft deletes

Author: prmerger-automator[bot]

articles/healthcare-apis/azure-api-for-fhir/export-data.md

@@ -15,7 +15,7 @@ ms.author: kesheth
 
 The Bulk Export feature allows data to be exported from the FHIR Server per the [FHIR specification](https://hl7.org/fhir/uv/bulkdata/export/index.html). 
 
-Before using $export, you'll want to make sure that the Azure API for FHIR is configured to use it. For configuring export settings and creating Azure storage account, refer to [the configure export data page](configure-export-data.md).
+Before using $export, you want to make sure that the Azure API for FHIR is configured to use it. For configuring export settings and creating Azure storage account, refer to [the configure export data page](configure-export-data.md).
 
 ## Using $export command
 
@@ -24,7 +24,7 @@ After configuring the Azure API for FHIR for export, you can use the $export com
 
 **Jobs stuck in a bad state**
 
-In some situations, there’s a potential for a job to be stuck in a bad state. This can occur especially if the storage account permissions haven’t been set up properly. One way to validate if your export is successful is to check your storage account to see if the corresponding container (that is, `ndjson`) files are present. If they aren’t present, and there are no other export jobs running, then there’s a possibility the current job is stuck in a bad state. You should cancel the export job by sending a cancellation request and try requeuing the job again. Our default run time for an export in bad state is 10 minutes before it will stop and move to a new job or retry the export. 
+In some situations, there’s a potential for a job to be stuck in a bad state. This can occur especially if the storage account permissions haven’t been set up properly. One way to validate export is to check your storage account to see if the corresponding container (that is, `ndjson`) files are present. If they aren’t present, and there are no other export jobs running, then there’s a possibility the current job is stuck in a bad state. You should cancel the export job by sending a cancellation request and try requeuing the job again. Our default run time for an export in bad state is 10 minutes before it will stop and move to a new job or retry the export. 
 
 The Azure API For FHIR supports $export at the following levels:
 * [System](https://hl7.org/Fhir/uv/bulkdata/export/index.html#endpoint---system-level-export): `GET https://<<FHIR service base URL>>/$export>>`
@@ -58,12 +58,14 @@ The Azure API for FHIR supports the following query parameters. All of these par
 
 |Query parameter        | Defined by the FHIR Spec?    |  Description|
 |------------------------|---|------------|
-| \_outputFormat | Yes | Currently supports three values to align to the FHIR Spec: application/fhir+ndjson, application/ndjson, or just ndjson. All export jobs will return `ndjson` and the passed value has no effect on code behavior. |
+| \_outputFormat | Yes | Currently supports three values to align to the FHIR Spec: application/fhir+ndjson, application/ndjson, or ndjson. All export jobs return `ndjson` and the passed value has no effect on code behavior. |
 | \_since | Yes | Allows you to only export resources that have been modified since the time provided |
 | \_type | Yes | Allows you to specify which types of resources will be included. For example, \_type=Patient would return only patient resources|
 | \_typefilter | Yes | To request finer-grained filtering, you can use \_typefilter along with the \_type parameter. The value of the _typeFilter parameter is a comma-separated list of FHIR queries that further restrict the results |
 | \_container | No |  Specifies the container within the configured storage account where the data should be exported. If a container is specified, the data will be exported into a folder into that container. If the container isn’t specified, the data will be exported to a new container. |
 | \_till | No |  Allows you to only export resources that have been modified till the time provided. This parameter is applicable to only System-Level export. In this case, if historical versions have not been disabled or purged, export guarantees true snapshot view, or, in other words, enables time travel. |
+|\_includeHistory | No | Allows you to export versioned resources. This filter does'nt work with '_typeFilter' query parameter. |
+|\_includeDeleted | No | Allows you to export soft deleted resources. To learn more about delete, refer to [delete using FHIR specification](https://www.hl7.org/fhir/http.html#delete). This filter does'nt work with '_typeFilter' query parameter. |
 
 > [!NOTE]
 > Only storage accounts in the same subscription as that for Azure API for FHIR are allowed to be registered as the destination for $export operations.

articles/healthcare-apis/fhir/export-data.md

@@ -66,7 +66,8 @@ The FHIR service supports the following query parameters for filtering exported
 | `_typeFilter` | Yes | To request finer-grained filtering, you can use `_typeFilter` along with the `_type` parameter. The value of the `_typeFilter` parameter is a comma-separated list of FHIR queries that further limit the results. |
 | `_container` | No |  Specifies the name of the container in the configured storage account where the data should be exported. If a container is specified, the data will be exported into a folder in that container. If the container isn't specified, the data will be exported to a new container with an autogenerated name. |
 | `_till` | No |  Allows you to export resources that have been modified till the specified time. This parameter is applicable only with System-Level export. In this case, if historical versions have not been disabled or purged, export guarantees true snapshot view, or, in other words, enables time travel. |
-
+|`__includeHistory` | No | Allows you to export versioned resources. This filter does'nt work with '_typeFilter' query parameter. |
+|`_includeDeleted` | No | Allows you to export soft deleted resources. To learn more about delete, refer to [delete using FHIR specification](https://www.hl7.org/fhir/http.html#delete). This filter does'nt work with '_typeFilter' query parameter. |
 > [!NOTE]
 > Only storage accounts in the same subscription as the FHIR service are allowed to be registered as the destination for `$export` operations.