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
Copy file name to clipboardExpand all lines: articles/healthcare-apis/fhir/how-to-do-custom-search.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,7 +17,7 @@ The FHIR specification defines a set of search parameters that apply to all reso
17
17
18
18
## Create new search parameter
19
19
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.
21
21
22
22
```rest
23
23
POST {{FHIR_URL}}/SearchParameter
@@ -70,7 +70,7 @@ Important elements of a `SearchParameter` resource:
70
70
71
71
*`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.
72
72
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.
74
74
75
75
*`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.
76
76
@@ -148,17 +148,17 @@ See [Running a reindex job](../fhir/how-to-run-a-reindex.md) for information on
148
148
149
149
## Update a search parameter
150
150
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.
152
152
153
153
> [!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`.
155
155
156
156
```rest
157
157
PUT {{FHIR_URL}}/SearchParameter/{{SearchParameter_ID}}
@@ -197,7 +197,7 @@ PUT {{FHIR_URL}}/SearchParameter/{{SearchParameter_ID}}
197
197
198
198
```
199
199
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.
201
201
202
202
> [!Warning]
203
203
> 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.
Copy file name to clipboardExpand all lines: articles/healthcare-apis/fhir/how-to-run-a-reindex.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ ms.author: mikaelw
13
13
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.
14
14
15
15
> [!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.
17
17
18
18
## How to run a reindex job
19
19
@@ -31,7 +31,7 @@ POST {{FHIR_URL}}/$reindex
31
31
}
32
32
```
33
33
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:
35
35
36
36
```json
37
37
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
|`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 |
189
189
|`MaximumResourcesPerQuery`| The maximum number of resources included in the batch of resources to be reindexed. | 100 | 1-5000 |
190
190
|`MaximumConcurrency`| The number of batches done at a time. | 1 | 1-10 |
191
191
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.
Copy file name to clipboardExpand all lines: articles/healthcare-apis/fhir/overview-of-search.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -160,7 +160,7 @@ Currently, the FHIR service in Azure Health Data Services only supports the `nex
160
160
161
161
## Next steps
162
162
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.
Copy file name to clipboardExpand all lines: articles/healthcare-apis/fhir/search-samples.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,7 +25,7 @@ Below are some examples of Fast Healthcare Interoperability Resources (FHIR®
25
25
```
26
26
27
27
> [!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.
29
29
30
30
### `_revinclude`
31
31
@@ -56,7 +56,7 @@ In the above request, you'll receive a bundle of patients, but each entry will o
56
56
GET {{FHIR_URL}}/Patient?gender:not=female
57
57
```
58
58
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.
0 commit comments