Skip to content

Commit 69dd545

Browse files
Merge pull request #209126 from v-pbartley/AHDS_docs_update
Ahds docs update
2 parents 8d4020d + 149f8f9 commit 69dd545

File tree

4 files changed

+17
-17
lines changed

4 files changed

+17
-17
lines changed

articles/healthcare-apis/fhir/how-to-do-custom-search.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ The FHIR specification defines a set of search parameters that apply to all reso
1717
1818
## Create new search parameter
1919

20-
To create a new search parameter, you `POST` a `SearchParameter` resource to the FHIR service database. The code example below shows how to add the [US Core Race search parameter](http://hl7.org/fhir/us/core/STU3.1.1/SearchParameter-us-core-race.html) to the `Patient` resource type in your FHIR service database.
20+
To create a new search parameter, you need to `POST` a `SearchParameter` resource to the FHIR service database. The code example below shows how to add the [US Core Race search parameter](http://hl7.org/fhir/us/core/STU3.1.1/SearchParameter-us-core-race.html) to the `Patient` resource type in your FHIR service database.
2121

2222
```rest
2323
POST {{FHIR_URL}}/SearchParameter
@@ -70,7 +70,7 @@ Important elements of a `SearchParameter` resource:
7070

7171
* `url`: A unique key to describe the search parameter. Organizations such as HL7 use a standard URL format for the search parameters that they define, as shown above in the US Core Race search parameter.
7272

73-
* `code`: The value stored in **code** is what you’ll use when searching. For the example above, you would search with `GET {{FHIR_URL}}/Patient?race=<code>` to retrieve all patients of a certain race. The coding system must be unique for the resource type(s) that the search parameter applies to.
73+
* `code`: The value stored in the **code** element is the name used for the search parameter when it is included in an API call. For the example above, you would search with `GET {{FHIR_URL}}/Patient?race=<code>` where `<code>` is in the value set from the specified coding system. This call would retrieve all patients of a certain race.
7474

7575
* `base`: Describes which resource type(s) the search parameter applies to. If the search parameter applies to all resources, you can use `Resource`; otherwise, you can list all the relevant resource types.
7676

@@ -148,17 +148,17 @@ See [Running a reindex job](../fhir/how-to-run-a-reindex.md) for information on
148148

149149
## Update a search parameter
150150

151-
To update a search parameter, use `PUT` to create a new version of the search parameter. You must include the `SearchParameter` ID in the `id` field in the body of the `PUT` request as well as the `PUT` request string.
151+
To update a search parameter, use `PUT` to create a new version of the search parameter. You must include the search parameter ID in the `id` field in the body of the `PUT` request as well as the `PUT` request string.
152152

153153
> [!NOTE]
154-
> If you don't know the ID for your search parameter, you can search for it using `GET {{FHIR_URL}}/SearchParameter`. This will return all custom search parameters, and you can scroll through the search parameter list to find the search parameter you need. You could also limit the search by name. With the example response below, you could search by name using `USCoreRace`: `GET {{FHIR_URL}}/SearchParameter?name=USCoreRace`.
154+
> If you don't know the ID for your search parameter, you can search for it using `GET {{FHIR_URL}}/SearchParameter`. This will return all custom as well as standard search parameters, and you can scroll through the list to find the search parameter you need. You could also limit the search by name. As shown in the example request below, the name of the custom `SearchParameter` resource instance is `USCoreRace`. You could search for this `SearchParameter` resource by name using `GET {{FHIR_URL}}/SearchParameter?name=USCoreRace`.
155155
156156
```rest
157157
PUT {{FHIR_URL}}/SearchParameter/{{SearchParameter_ID}}
158158
159159
{
160160
"resourceType" : "SearchParameter",
161-
"id" : "{SearchParameter ID}",
161+
"id" : "{{SearchParameter_ID}}",
162162
"url" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-race",
163163
"version" : "3.1.1",
164164
"name" : "USCoreRace",
@@ -197,7 +197,7 @@ PUT {{FHIR_URL}}/SearchParameter/{{SearchParameter_ID}}
197197
198198
```
199199

200-
The result will be an updated `SearchParameter` and the version will increment.
200+
The result of the above request will be an updated `SearchParameter` resource.
201201

202202
> [!Warning]
203203
> Be careful when updating search parameters. Changing an existing search parameter could have impacts on the expected behavior. We recommend running a reindex job immediately.

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

articles/healthcare-apis/fhir/overview-of-search.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ Currently, the FHIR service in Azure Health Data Services only supports the `nex
160160

161161
## Next steps
162162

163-
Now that you've learned about the basics of FHIR search, see the search samples page for details about how to search using different search parameters, modifiers, and FHIR search methods.
163+
Now that you've learned about the basics of FHIR search, see the search samples page for details about how to search using search parameters, modifiers, and other FHIR search methods.
164164

165165
>[!div class="nextstepaction"]
166166
>[FHIR search examples](search-samples.md)

articles/healthcare-apis/fhir/search-samples.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Below are some examples of Fast Healthcare Interoperability Resources (FHIR&#174
2525
```
2626

2727
> [!NOTE]
28-
> The FHIR service in Azure Health Data Services limits searches with `_include` and `_revinclude` to return 100 items.
28+
> The FHIR service in Azure Health Data Services limits searches with `_include` and `_revinclude` to return a maximum of 100 items.
2929
3030
### `_revinclude`
3131

@@ -56,7 +56,7 @@ In the above request, you'll receive a bundle of patients, but each entry will o
5656
GET {{FHIR_URL}}/Patient?gender:not=female
5757
```
5858

59-
In return, you would get all `Patient` resources whose `gender` element value is not `female`, including any patients with no gender value specified. This is different from searching for `Patient` resources with the `male` gender value, since that search wouldn't return any patients that don't have a specified gender.
59+
In return, you would get all `Patient` resources whose `gender` element value is not `female`, including any patients with no gender value specified. This is different from searching for `Patient` resources with the `male` gender value since that would ignore patients with no specified gender.
6060

6161
### `:missing`
6262

0 commit comments

Comments
 (0)