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
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.
17
17
18
18
## Conditional create/update
19
19
@@ -27,7 +27,7 @@ Azure API for FHIR offers two delete types. There's [Delete](https://www.hl7.org
27
27
28
28
### Delete (Hard + Soft Delete)
29
29
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.
31
31
32
32
> [!NOTE]
33
33
> 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
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.
54
54
55
55
If the ID of the resource that was deleted is known, use the following URL pattern:
56
56
@@ -67,7 +67,7 @@ For example: `https://myworkspace-myfhirserver.fhir.azurehealthcareapis.com/Pati
67
67
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.
68
68
69
69
> [!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.
71
71
72
72
## Batch Bundles
73
73
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
128
128
129
129
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.
130
130
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.
0 commit comments