Skip to content

Commit 0095cec

Browse files
authored
Update fhir-rest-api-capabilities.md
1 parent 113589c commit 0095cec

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

articles/healthcare-apis/azure-api-for-fhir/fhir-rest-api-capabilities.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ ms.author: kesheth
1313

1414
[!INCLUDE [retirement banner](../includes/healthcare-apis-azure-api-fhir-retirement.md)]
1515

16-
In this article, we'll cover some of the nuances of the RESTful interactions of Azure API for FHIR.
16+
In this article, we cover some of the nuances of the RESTful interactions of Azure API for FHIR.
1717

1818
## Conditional create/update
1919

@@ -27,7 +27,7 @@ Azure API for FHIR offers two delete types. There's [Delete](https://www.hl7.org
2727

2828
### Delete (Hard + Soft Delete)
2929

30-
Delete defined by the FHIR specification requires that after deleting a resource, subsequent non-version specific reads of a resource returns a 410 HTTP status code. Therefore, the resource is no longer found through searching. Additionally, Azure API for FHIR enables you to fully delete (including all history) the resource. To fully delete the resource, you can pass a parameter settings `hardDelete` to true `(DELETE {{FHIR_URL}}/{resource}/{id}?hardDelete=true)`. If you don't pass this parameter or set `hardDelete` to false, the historic versions of the resource will still be available.
30+
Delete defined by the FHIR specification requires that after deleting a resource, subsequent nonversion specific reads of a resource returns a 410 HTTP status code. Therefore, the resource is no longer found through searching. Additionally, Azure API for FHIR enables you to fully delete (including all history) the resource. To fully delete the resource, you can pass a parameter settings `hardDelete` to true `(DELETE {{FHIR_URL}}/{resource}/{id}?hardDelete=true)`. If you don't pass this parameter or set `hardDelete` to false, the historic versions of the resource will still be available.
3131

3232
> [!NOTE]
3333
> If you only want to delete the history, Azure API for FHIR supports a custom operation called `$purge-history`. This operation allows you to delete the history off of a resource.
@@ -44,13 +44,13 @@ You can do the same search but include `hardDelete=true` to also delete all hist
4444

4545
`DELETE https://{{FHIR_URL}}/Patient?identifier=1032704&hardDelete=true`
4646

47-
To delete multiple resources, include `_count=100` parameter. This parameter will delete up to 100 resources that match the search criteria.
47+
To delete multiple resources, include `_count=100` parameter. This parameter deletes up to 100 resources that match the search criteria.
4848

4949
`DELETE https://{{FHIR_URL}}/Patient?identifier=1032704&_count=100`
5050

5151
### Recovery of deleted files
5252

53-
If you don't use the hard delete parameter, then the record(s) in Azure API for FHIR should still exist. The record(s) can be found by doing a history search on the resource and looking for the last version with data.
53+
If you don't use the hard delete parameter, then the records in Azure API for FHIR should still exist. The records can be found by doing a history search on the resource and looking for the last version with data.
5454

5555
If the ID of the resource that was deleted is known, use the following URL pattern:
5656

@@ -67,7 +67,7 @@ For example: `https://myworkspace-myfhirserver.fhir.azurehealthcareapis.com/Pati
6767
After you've found the record you want to restore, use the `PUT` operation to recreate the resource with the same ID, or use the `POST` operation to make a new resource with the same information.
6868

6969
> [!NOTE]
70-
> There is no time-based expiration for history/soft delete data. The only way to remove history/soft deleted data is with a hard delete or the purge history operation.\
70+
> There is no time-based expiration for history/soft delete data. The only way to remove history/soft deleted data is with a hard delete or the purge history operation.
7171
7272
## Batch Bundles
7373
In FHIR, bundles can be considered as a container that holds multiple resources. Batch bundles enable users to submit a set of actions to be performed on a server in single HTTP request/response.
@@ -128,8 +128,8 @@ In the case of a batch, each entry is treated as an individual interaction or op
128128

129129
Currently batch bundles are executed serially in FHIR service. To improve performance and throughput, we're enabling parallel processing of batch bundles in public preview.
130130
To use the capability of parallel batch bundle processing-
131-
* Set header x-bundle-processing-logic value to parallel.
132-
* Ensure there's no overlapping resource ID that is executing on DELETE, POST, PUT or PATCH operations in the same bundle.
131+
* Set header 'x-bundle-processing-logic' value to 'parallel'.
132+
* Ensure there's no overlapping resource ID that is executing on DELETE, POST, PUT, or PATCH operations in the same bundle.
133133

134134
## Patch and Conditional Patch
135135

0 commit comments

Comments
 (0)