Skip to content

Commit

Permalink
GITBOOK-3020: Add info about 'or' in _filter
Browse files Browse the repository at this point in the history
  • Loading branch information
Health Samurai authored and gitbook-bot committed Nov 10, 2023
1 parent 2cba573 commit e46ce8b
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions api-1/fhir-api/search-1/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ description: Search API for FHIR resources

# Search



Aidbox provides a Search API for all stored resources. Aidbox Search API is a superset of the [FHIR Search API](https://www.hl7.org/fhir/search.html).

{% hint style="info" %}
Expand Down Expand Up @@ -58,7 +56,7 @@ GET /Patient?name=Max&_elements=id, birthDAte
## Special Parameters
<table><thead><tr><th width="180">Parameter</th><th width="145.33333333333331">Type</th><th>Description</th></tr></thead><tbody><tr><td><a href="search-parameters-list/_text-and-_content.md">_content</a></td><td>FHIR</td><td>Full text search by resource content</td></tr><tr><td><a href="search-parameters-list/_elements.md">_elements</a></td><td>FHIR+</td><td>Include or exclude specific resource elements</td></tr><tr><td><a href="search-parameters-list/_explain.md">_explain</a></td><td></td><td>Get query execution plan</td></tr><tr><td>_has</td><td>FHIR</td><td></td></tr><tr><td><a href="search-parameters-list/_id.md">_id</a></td><td>FHIR</td><td>Search and sort by resource id</td></tr><tr><td><a href="search-parameters-list/_ilike.md">_ilike</a></td><td></td><td><code>ILIKE</code> search by resource content</td></tr><tr><td><a href="search-parameters-list/_include-and-_revinclude.md">_include</a></td><td>FHIR</td><td>Include referenced resources into result</td></tr><tr><td><a href="search-parameters-list/_lastupdated.md">_lastUpdated</a></td><td>FHIR</td><td>Search and sort by resource last modification date</td></tr><tr><td><a href="search-parameters-list/_list.md">_list</a></td><td>FHIR</td><td>Search resources included into specific List</td></tr><tr><td><a href="search-parameters-list/_profile.md">_profile</a></td><td>FHIR</td><td>Search by resource profile</td></tr><tr><td><a href="search-parameters-list/_result.md">_result</a></td><td></td><td>Change result format</td></tr><tr><td><a href="search-parameters-list/_include-and-_revinclude.md">_revinclude</a></td><td>FHIR</td><td>Include into result resources, which reference searched resources</td></tr><tr><td>_security</td><td>FHIR</td><td></td></tr><tr><td><a href="search-parameters-list/_sort.md">_sort</a></td><td>FHIR</td><td>Sort search results</td></tr><tr><td><a href="search-parameters-list/_summary.md">_summary</a></td><td>FHIR</td><td>Include only summary elements</td></tr><tr><td>_tag</td><td>FHIR</td><td></td></tr><tr><td><a href="search-parameters-list/_text-and-_content.md">_text</a></td><td>FHIR</td><td>Full text search by resource narrative</td></tr><tr><td><a href="search-parameters-list/_total-or-_countmethod.md">_total</a></td><td>FHIR</td><td>Turn on/off total count</td></tr><tr><td><a href="search-parameters-list/_include-and-_revinclude.md">_with</a></td><td>Aidbox</td><td>Include into result resources (compact way compared to _include and _revinclude)</td></tr></tbody></table>
<table><thead><tr><th width="180">Parameter</th><th width="145.33333333333331">Type</th><th>Description</th></tr></thead><tbody><tr><td><a href="search-parameters-list/_text-and-_content.md">_content</a></td><td>FHIR</td><td>Full text search by resource content</td></tr><tr><td><a href="search-parameters-list/_elements.md">_elements</a></td><td>FHIR+</td><td>Include or exclude specific resource elements</td></tr><tr><td><a href="search-parameters-list/_explain.md">_explain</a></td><td></td><td>Get query execution plan</td></tr><tr><td>_filter</td><td>FHIR</td><td>Perform an advanced search</td></tr><tr><td>_has</td><td>FHIR</td><td></td></tr><tr><td><a href="search-parameters-list/_id.md">_id</a></td><td>FHIR</td><td>Search and sort by resource id</td></tr><tr><td><a href="search-parameters-list/_ilike.md">_ilike</a></td><td></td><td><code>ILIKE</code> search by resource content</td></tr><tr><td><a href="search-parameters-list/_include-and-_revinclude.md">_include</a></td><td>FHIR</td><td>Include referenced resources into result</td></tr><tr><td><a href="search-parameters-list/_lastupdated.md">_lastUpdated</a></td><td>FHIR</td><td>Search and sort by resource last modification date</td></tr><tr><td><a href="search-parameters-list/_list.md">_list</a></td><td>FHIR</td><td>Search resources included into specific List</td></tr><tr><td><a href="search-parameters-list/_profile.md">_profile</a></td><td>FHIR</td><td>Search by resource profile</td></tr><tr><td><a href="search-parameters-list/_result.md">_result</a></td><td></td><td>Change result format</td></tr><tr><td><a href="search-parameters-list/_include-and-_revinclude.md">_revinclude</a></td><td>FHIR</td><td>Include into result resources, which reference searched resources</td></tr><tr><td>_security</td><td>FHIR</td><td></td></tr><tr><td><a href="search-parameters-list/_sort.md">_sort</a></td><td>FHIR</td><td>Sort search results</td></tr><tr><td><a href="search-parameters-list/_summary.md">_summary</a></td><td>FHIR</td><td>Include only summary elements</td></tr><tr><td>_tag</td><td>FHIR</td><td></td></tr><tr><td><a href="search-parameters-list/_text-and-_content.md">_text</a></td><td>FHIR</td><td>Full text search by resource narrative</td></tr><tr><td><a href="search-parameters-list/_total-or-_countmethod.md">_total</a></td><td>FHIR</td><td>Turn on/off total count</td></tr><tr><td><a href="search-parameters-list/_include-and-_revinclude.md">_with</a></td><td>Aidbox</td><td>Include into result resources (compact way compared to _include and _revinclude)</td></tr></tbody></table>
## Search Parameters
Expand All @@ -72,7 +70,7 @@ Depending on the value type, different modifiers can be applied.
## Supported modifiers
<table><thead><tr><th width="130.33333333333331">Modifier</th><th width="221">Types</th><th>Description</th></tr></thead><tbody><tr><td>missing</td><td>all</td><td>Tests whether the value in a resource is present (when the supplied parameter value is <code>true</code>) or absent (when the supplied parameter value is <code>false</code>)</td></tr><tr><td>text</td><td>string, token, reference, uri</td><td>Tests whether the textual value in a resource matches the supplied parameter value using basic string matching (begins with or is, case-insensitive)</td></tr><tr><td>below</td><td>uri</td><td>Tests whether the value in a resource is or is subsumed by the supplied parameter value (is-a, or hierarchical relationships)</td></tr><tr><td>contains</td><td>string</td><td>Case insensitive, partial match at start or end</td></tr><tr><td>ends, ew</td><td>string</td><td>Case insensitive, partial match at end</td></tr><tr><td>exact</td><td>string</td><td>No partial matches, case sensitive</td></tr><tr><td>starts, sw</td><td>string</td><td>Case insensitive, partial match at start</td></tr><tr><td>btw</td><td>date</td><td>Search between two dates</td></tr><tr><td>identifier</td><td>reference</td><td>Tests whether the <code>Reference.identifier</code> in a resource (rather than the <code>Reference.reference</code>) matches the supplied parameter value</td></tr><tr><td>not</td><td>reference, token, uri</td><td>Reverses the code matching: returns all resources that do not have a matching item.</td></tr><tr><td>i</td><td>token</td><td>Case insensitive, exact match of text associated with token or token itself</td></tr><tr><td>in</td><td>token</td><td>Tests whether the value in a resource is a member of the supplied parameter ValueSet</td></tr><tr><td>of-type</td><td>token (only Identifier)</td><td>Tests whether the <code>Identifier</code> value in a resource matches the supplied parameter value</td></tr><tr><td>iterate, reverse, logical</td><td>n/a</td><td>See <a href="search-parameters-list/_include-and-_revinclude.md">_include</a></td></tr></tbody></table>
<table><thead><tr><th width="130.33333333333331">Modifier</th><th width="221">Types</th><th>Description</th></tr></thead><tbody><tr><td>missing</td><td>all</td><td>Tests whether the value in a resource is present (when the supplied parameter value is <code>true</code>) or absent (when the supplied parameter value is <code>false</code>)</td></tr><tr><td>text</td><td>string, token, reference, uri</td><td>Tests whether the textual value in a resource matches the supplied parameter value using basic string matching (begins with or is, case-insensitive)</td></tr><tr><td>below</td><td>uri</td><td>Tests whether the value in a resource is or is subsumed by the supplied parameter value (is-a, or hierarchical relationships)</td></tr><tr><td>contains</td><td>string</td><td>Case insensitive, partial match at start or end</td></tr><tr><td>ends, ew</td><td>string</td><td>Case insensitive, partial match at end</td></tr><tr><td>exact</td><td>string</td><td>No partial matches, case sensitive</td></tr><tr><td>starts, sw</td><td>string</td><td>Case insensitive, partial match at start</td></tr><tr><td>btw</td><td>date</td><td>Search between two dates</td></tr><tr><td>identifier</td><td>reference</td><td>Tests whether the <code>Reference.identifier</code> in a resource (rather than the <code>Reference.reference</code>) matches the supplied parameter value</td></tr><tr><td>not</td><td>reference, token, uri</td><td>Reverses the code matching: returns all resources that do not have a matching item.</td></tr><tr><td>i</td><td>token</td><td>Case insensitive, exact match of text associated with token or token itself</td></tr><tr><td>in</td><td>token</td><td>Tests whether the value in a resource is a member of the supplied parameter ValueSet</td></tr><tr><td>of-type</td><td>token (only Identifier)</td><td>Tests whether the <code>Identifier</code> value in a resource matches the supplied parameter value</td></tr><tr><td>iterate, reverse, logical</td><td>n/a</td><td>See <a href="search-parameters-list/_include-and-_revinclude.md">_include</a></td></tr></tbody></table>
### Search with modifiers examples
Expand Down Expand Up @@ -288,7 +286,7 @@ entry: []
#### X-Original-Uri header
This header allows you completely overwrite content of `url` param. Aidbox will automatically add `page` param to your link, or replace if it exists. For example:
This header allows you completely overwrite content of `url` param. Aidbox will automatically add `page` param to your link, or replace if it exists. For example:

```yaml
GET /fhir/Patient?name=example
Expand Down

0 comments on commit e46ce8b

Please sign in to comment.