Skip to content

Commit 2af2878

Browse files
committed
Updated how-to-run-a-reindex.md
1 parent f9d288f commit 2af2878

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

articles/healthcare-apis/fhir/how-to-run-a-reindex.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ ms.author: mikaelw
1313
There are scenarios where you may have search parameters in the FHIR service in Azure Health Data Services that haven't yet been indexed. This is the case when you define your own custom search parameters. Until the search parameter is indexed, it can't be used in live production. This article covers how to run a reindex job to index any custom search parameters that haven't yet been indexed in your FHIR service database.
1414

1515
> [!Warning]
16-
> It's important that you read this entire article before getting started. A reindex job can be very performance intensive. This article discusses options for how to throttle and control the reindex job.
16+
> It's important that you read this entire article before getting started. A reindex job can be very performance intensive. This article discusses options for how to throttle and control a reindex job.
1717
1818
## How to run a reindex job
1919

@@ -31,7 +31,7 @@ POST {{FHIR_URL}}/$reindex
3131
}
3232
```
3333

34-
Leave the `"parameter": []` field blank (as shown) if you don't need to tweak the compute resources allocated to the reindex job. If the request is successful, you will receive a **201 Created** status code. The FHIR service will also return a `Parameters` resource in response:
34+
Leave the `"parameter": []` field blank (as shown) if you don't need to tweak the compute resources allocated to the reindex job. If the request is successful, you will receive a **201 Created** status code in addition to a `Parameters` resource in response:
3535

3636
```json
3737
HTTP/1.1 201 Created
@@ -93,7 +93,7 @@ Once you’ve started a reindex job, you can check the status of the job using t
9393

9494
`GET {{FHIR_URL}}/_operations/reindex/{{reindexJobId}}`
9595

96-
The status of the reindex job result is shown below:
96+
An example response is shown below:
9797

9898
```json
9999
{
@@ -150,17 +150,17 @@ The status of the reindex job result is shown below:
150150

151151
"name": "resources",
152152
"valueString":
153-
"{LIST OF IMPACTED RESOURCES}"
153+
"{{LIST_OF_IMPACTED_RESOURCES}}"
154154
}
155155
]
156156
}
157157
```
158158

159-
The following information is shown in the reindex job result:
159+
The following information is shown in the above response:
160160

161161
* `totalResourcesToReindex`: Includes the total number of resources that are being reindexed in this job.
162162

163-
* `resourcesSuccessfullyReindexed`: The total that have already been successfully reindexed.
163+
* `resourcesSuccessfullyReindexed`: The total number of resources that have already been reindexed in this job.
164164

165165
* `progress`: Reindex job percent complete. Equals `resourcesSuccessfullyReindexed`/`totalResourcesToReindex` x 100.
166166

@@ -185,11 +185,11 @@ Below is a table outlining the available parameters, defaults, and recommended r
185185

186186
| **Parameter** | **Description** | **Default** | **Available Range** |
187187
| --------------------------------- | ---------------------------- | ------------------ | ------------------------------- |
188-
| `QueryDelayIntervalInMilliseconds` | The delay between each batch of resources being kicked off during the reindex job. A smaller number will speed up the job while a bigger number will slow it down. | 500 MS (.5 seconds) | 50 to 500000 |
188+
| `QueryDelayIntervalInMilliseconds` | The delay between each batch of resources being kicked off during the reindex job. A smaller number will speed up the job while a larger number will slow it down. | 500 MS (.5 seconds) | 50 to 500000 |
189189
| `MaximumResourcesPerQuery` | The maximum number of resources included in the batch of resources to be reindexed. | 100 | 1-5000 |
190190
| `MaximumConcurrency` | The number of batches done at a time. | 1 | 1-10 |
191191

192-
If you want to use any of the parameters above, you can pass them into the `Parameters` resource when you send a `POST` request to start a reindex job.
192+
If you want to use any of the parameters above, you can pass them into the `Parameters` resource when you send the initial `POST` request to start a reindex job.
193193

194194
```json
195195

0 commit comments

Comments
 (0)