Skip to content

Commit 23fb423

Browse files
authored
Merge pull request #298388 from EXPEkesheth/patch-214602
reverting the change of include and revinclude
2 parents a1dfcbf + 038cd9a commit 23fb423

File tree

1 file changed

+0
-60
lines changed

1 file changed

+0
-60
lines changed

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

Lines changed: 0 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -144,66 +144,6 @@ Note:
144144

145145
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`.
146146

147-
##### _include and _revinclude searches
148-
149-
The FHIR service supports 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 clinical resource, and any other resources that it references. When included in the query, the `_include` parameter returns both the specified resource and its referenced resources.
152-
153-
The `_revinclude` search parameter allows for 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).
154-
155-
##### Request parameters
156-
157-
When executing a search request with the `_include` and `_revinclude` parameter, the following optional parameters can be used to control the count.
158-
159-
| **Name** | **Value** | **Description** |
160-
| -------- | --------- | --------------- |
161-
| `_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 isn't provided, it's set to 10. |
162-
| `_includesCount` | Default value: 1000 | The value represents the number of matching resources referenced by target resources to be retrieved per request. |
163-
164-
For matched items from `_include` and `_revinclude` searches, a maximum of 1,000 items is included in the response. If the number of matched items exceeds 1,000, a link is provided which allows you to navigate the complete result set.
165-
166-
Example:
167-
168-
In the following example, a search request for Observations is made for Patient with Identifier 123.
169-
170-
```
171-
GET {{FHIR_URL}}/Observation?subject.identifier=123&_include=Observation:subject&_includesCount=10
172-
```
173-
174-
The response returned contains observation data for Patient 123. The matched resource references are given 10 per page, and a link is provided which contains the $include operation. You can follow the link to move through the result set.
175-
176-
```
177-
{
178-
"resourceType": "Bundle",
179-
180-
"id": "b5491e39-8f8f-4405-a4cf-2a6716755d73",
181-
"meta": {
182-
"lastUpdated": "2025-04-10T21:09:42.6517693+00:00"
183-
},
184-
"type": "searchset",
185-
"link": [
186-
{
187-
"relation": "next",
188-
"url": "{{FHIR_URL}}/Observation?subject.identifier=123&_include=Observation:subject&_includesCount=10&ct=er97f5lRTbShgbGOqaGhgbGlsZGFmaWJiYWBgYGpSSwAAAD%2F%2Fw%3D%3D"
189-
},
190-
191-
{
192-
"relation": "related",
193-
"url": "{{FHIR_URL}}/Observation?subject.identifier=123&_include=Observation:subject&_includesCount=10&includesCt=er97f5lRTbShgbGOqaGhgbGlsZGFmaWJiYWBgYGhAaaYqYmOqQUWYaNYAAAAAP%2F%2F"
194-
},
195-
{
196-
"relation": "self",
197-
"url": "{{FHIR_URL}}/Observation?subject.identifier=123&_include=Observation:subject&_includesCount=10”
198-
}
199-
],
200-
"entry": [….]
201-
}
202-
```
203-
204-
> [!NOTE]
205-
> Queries with wild card *.* for `_revinclude` are limited to 100 matches overall.
206-
207147
## Chained & reverse chained searching
208148

209149
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

Comments
 (0)