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/overview-of-search.md
+74Lines changed: 74 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -144,6 +144,80 @@ Note:
144
144
145
145
By default, the FHIR service in Azure Health Data Services is set to lenient handling. This means that the server ignores any unknown or unsupported parameters. If you want to use strict handling, you can include the `Prefer` header and set `handling=strict`.
146
146
147
+
#### _include and _revinclude searches
148
+
149
+
The FHIR service support search queries using the `_include` and `_revinclude` parameters. These parameters allow for the retrieval of reference resources in the search results.
150
+
151
+
The `_include` search parameter enables the retrieval of a particular FHIR resource, as well as any other FHIR resources that are referenced by it. When used in a query, the `_include` parameter returns the specified resource and resources *it references*. The `_revinclude` search parameter operates in the reverse, allowing the retrieval of a resource, along with any other resources that *reference it*, providing a way to search for resources based on their relationships with other resources. For detailed information on include and revinclude in search parameters, refer to the [FHIR Search Documentation](https://www.hl7.org/fhir/R4/search.html#revinclude).
152
+
153
+
##### Request parameters
154
+
155
+
When executing a search request with `_include` and `_revinclude` parameters, the following optional parameters can be used to control the count.
|`_count`| Default value: 10 Max value: 1000 | The value represents the number of targeted resources to be retrieved per request. The value can be set up to 1000. When the parameter is not provided, it is set to 10. |
160
+
|`_includesCount`| Default value: 1000 | The value represents the number of matches resources referenced by target resources to be retrieved per request. |
161
+
162
+
A maximum of 1000 items are included in the response from `_include` and `_revinclude` searches. If there are more than 1,000 matched items, a link is provided allowing you to navigate the complete result set.
163
+
164
+
In the following example, a search request for Observations is made for Patient with Identifier 123.
165
+
166
+
```
167
+
GET {{FHIR_URL}}/Observation?subject.identifier=123&_include=Observation:subject&_includesCount=10
168
+
```
169
+
170
+
The response will have Observation data for Patient 123. The matched resources are provided 10 per page, with a link provided to navigate the complete result set.
A [chained search](https://www.hl7.org/fhir/search.html#chaining) allows you to perform fine-targeted queries for resources that have a reference to another resource. For example, if you want to find encounters where the patient’s name is Jane, use:
0 commit comments