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/azure-api-for-fhir/overview-of-search.md
+13-13Lines changed: 13 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ author: expekesheth
5
5
ms.service: azure-health-data-services
6
6
ms.subservice: fhir
7
7
ms.topic: reference
8
-
ms.date: 9/27/2023
8
+
ms.date: 11/21/2025
9
9
ms.author: kesheth
10
10
---
11
11
@@ -21,11 +21,11 @@ FHIR searches can be against a specific resource type, a specified [compartment]
21
21
GET {{FHIR_URL}}/Patient
22
22
```
23
23
24
-
You can also search using `POST`, which is useful if the query string is long. To search using `POST`, the search parameters can be submitted as a form body. This allows for longer, more complex series of query parameters that might be difficult to see and understand in a query string.
24
+
You can also search using `POST`, which is useful if the query string is long. To search using `POST`, the search parameters can be submitted as a form body, allowing for a longer, more complex series of query parameters that might be difficult to see and understand in a query string.
25
25
26
26
If the search request is successful, you receive a FHIR bundle response with the type `searchset`. If the search fails, you can find the error details in the `OperationOutcome` to help you understand why the search failed.
27
27
28
-
In the following sections, we cover the various aspects involved in searching. Once you’ve reviewed these details, refer to our [samples page](search-samples.md) that has examples of searches that you can make in the Azure API for FHIR.
28
+
In the following sections, we cover the various aspects involved in searching. After reviewing these details, refer to our [samples page](search-samples.md) that has examples of searches that you can make in the Azure API for FHIR.
29
29
30
30
## Search parameters
31
31
@@ -34,7 +34,7 @@ Searches are based on various attributes of the resource. These attributes are c
34
34
Each search parameter has a defined [data types](https://www.hl7.org/fhir/search.html#ptypes). The following table outlines support for the various data types.
35
35
36
36
> [!WARNING]
37
-
> There is currently an issue when using `_sort` on the Azure API for FHIR with chained search. For more information, see the open-source issue [#2344](https://github.com/microsoft/fhir-server/issues/2344). This will be resolved during a release in December 2021.
37
+
> There was an issue using `_sort` on the Azure API for FHIR with chained search. This was resolved during a later release. For more information, see the open-source issue [#2344](https://github.com/microsoft/fhir-server/issues/2344).
38
38
39
39
|**Search parameter type**|**Azure API for FHIR**|**FHIR service in Azure Health Data Services**|**Comment**|
@@ -50,7 +50,7 @@ Each search parameter has a defined [data types](https://www.hl7.org/fhir/search
50
50
51
51
### Common search parameters
52
52
53
-
There are [common search parameters](https://www.hl7.org/fhir/search.html#all) that apply to all resources. These are in the following list, along with their support within the Azure API for FHIR.
53
+
There are [common search parameters](https://www.hl7.org/fhir/search.html#all) that apply to all resources. These parameters are given in the following list, along with their support within the Azure API for FHIR.
54
54
55
55
|**Common search parameter**|**Azure API for FHIR**|**FHIR service in Azure Health Data Services**|**Comment**|
To see the search parameters in the capability statement, navigate to `CapabilityStatement.rest.resource.searchParam` to see the search parameters for each resource, and `CapabilityStatement.rest.searchParam` to find the search parameters for all resources.
85
85
86
86
> [!NOTE]
87
-
> The Azure API for FHIR does not automatically create or index any search parameters that are not defined by the FHIR specification. However, we do provide support for you to define your own [search parameters](how-to-do-custom-search.md).
87
+
> The Azure API for FHIR doesn't automatically create or index any search parameters not defined by the FHIR specification. However, we do provide support for you to define your own [search parameters](how-to-do-custom-search.md).
88
88
89
89
### Composite search parameters
90
-
Composite search allows you to search against value pairs. For example, if you were searching for a height observation where the person was 60 inches, you would want to make sure that a single component of the observation contained the code of height **and** the value of 60. You wouldn't want to get an observation where a weight of 60 and height of 48 was stored, even though the observation would have entries that qualified for value of 60 and code of height, just in different component sections.
90
+
Composite search allows you to search against value pairs. For example, if you were searching for a height observation where the person was 60 inches, you would want to make sure that a single component of the observation contained the code of height **and** the value of 60. If not, you could get results that include 60, but not for height. For instance, a weight of 60 and height of 48. Both parameters meet the search condition, but not in the same field.
91
91
92
92
With the Azure API for FHIR, we support the following search parameter type pairings.
93
93
@@ -101,7 +101,7 @@ With the Azure API for FHIR, we support the following search parameter type pair
101
101
For more information, see the HL7 [Composite Search Parameters](https://www.hl7.org/fhir/search.html#composite).
102
102
103
103
> [!NOTE]
104
-
> Composite search parameters do not support modifiers per the FHIR specification.
104
+
> Composite search parameters don't support modifiers per the FHIR specification.
105
105
106
106
### Modifiers & prefixes
107
107
@@ -130,12 +130,12 @@ To help manage the returned resources, there are search result parameters that y
130
130
|**Search result parameters**|**Azure API for FHIR**|**FHIR service in Azure Health Data Services**|**Comment**|
|_count | Yes | Yes |_count is limited to 1000 resources. If set higher than 1000, only 1000 are returned and a warning will be returned in the bundle. |
133
+
|_count | Yes | Yes |_count is limited to 1,000 resources. If set higher than 1,000, only 1,000 are returned and a warning is returned in the bundle. |
134
134
|_include | Yes | Yes | Included items are limited to 100. _include on PaaS and OSS on Azure Cosmos DB don't include :iterate support [(#2137)](https://github.com/microsoft/fhir-server/issues/2137). |
135
135
|_revinclude | Yes | Yes |Included items are limited to 100. _revinclude on PaaS and OSS on Azure Cosmos DB don't include :iterate support [(#2137)](https://github.com/microsoft/fhir-server/issues/2137). There's also an incorrect status code for a bad request [#1319](https://github.com/microsoft/fhir-server/issues/1319)|
136
136
|_summary | Yes | Yes ||
137
137
|_total | Partial | Partial |_total=none and _total=accurate |
138
-
|_sort | Partial | Partial | sort=_lastUpdated is supported on Azure API for FHIR and the FHIR service. For Azure API for FHIR and OSS Azure Cosmos DB databases created after April 20, 2021, sort is supported on first name, last name, birthdate, and clinical date. |
138
+
|_sort | Partial | Partial | sort=_lastUpdated is supported on Azure API for FHIR and the FHIR service. For Azure API for FHIR and OSS Azure Cosmos DB databases created after April 20, 2021, sort is supported on first name, family name, birthdate, and clinical date. |
139
139
|_contained | No | No ||
140
140
|_containedType | No | No ||
141
141
|_score | No | No ||
@@ -154,11 +154,11 @@ A [chained search](https://www.hl7.org/fhir/search.html#chaining) allows you to
154
154
Similarly, you can do a reverse chained search. This allows you to get resources where you specify criteria on other resources that refer to them. For more examples of chained and reverse chained search, refer to the [FHIR search examples](search-samples.md) page.
155
155
156
156
> [!NOTE]
157
-
> In the Azure API for FHIR and the open source backed by Azure Cosmos DB, there's a limitation where each subquery required for the chained and reverse chained searches will only return 1000 items. If there are more than 1000 items found, you’ll receive the following error message: “Subqueries in a chained expression can't return more than 1000 results, please use a more selective criteria.” To get a successful query, you’ll need to be more specific in what you are looking for.
157
+
> In the Azure API for FHIR and the open source backed by Azure Cosmos DB, there's a limitation where each subquery required for the chained and reverse chained searches only return 1,000 items. If more than 1,000 items found, you receive the following error message: "Subqueries in a chained expression can't return more than 1,000 results, please use a more selective criteria." A successful query needs to be specific regarding what you are looking for.
158
158
159
159
## Pagination
160
160
161
-
As previously mentioned, the results from a search are a paged bundle. By default, the search returns 10 results per page, but this can be increased (or decreased) by specifying `_count`. Within the bundle, there will be a self link that contains the current result of the search. If there are additional matches, the bundle will contain a next link. You can continue to use the next link to get the subsequent pages of results. `_count` is limited to 1,000 items or less.
161
+
As previously mentioned, the results from a search are a paged bundle. By default the search returns 10 results per page, which can be increased (or decreased) by specifying `_count`. Within the bundle, there will be a self link that contains the current result of the search. If there are other matches, the bundle will contain a next link. You can continue to use the next link to get the subsequent pages of results. `_count` is limited to 1,000 items or less.
162
162
163
163
The next link in the bundle has a continuation token size limit of 3 KB. You have flexibility to tweak the continuation token size between 1 KB to 3 KB, using header `x-ms-documentdb-responsecontinuationtokenlimitinkb`.
164
164
@@ -171,4 +171,4 @@ Now that you learned about the basics of search, see the search samples page for
Copy file name to clipboardExpand all lines: articles/healthcare-apis/azure-api-for-fhir/policy-reference.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
@@ -1,7 +1,7 @@
1
1
---
2
2
title: Built-in policy definitions for Azure API for FHIR
3
3
description: Lists Azure Policy built-in policy definitions for Azure API for FHIR. These built-in policy definitions provide common approaches to managing your Azure resources.
![prmerger-automator[bot]](https://avatars.githubusercontent.com/u/22479449?v=4&size=40){kind=avatar}
0 commit comments