From e46ce8b78429fe9014df896c0d6a5eebe7b60c5d Mon Sep 17 00:00:00 2001 From: Health Samurai Date: Fri, 10 Nov 2023 17:04:20 +0000 Subject: [PATCH] GITBOOK-3020: Add info about 'or' in _filter --- api-1/fhir-api/search-1/README.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/api-1/fhir-api/search-1/README.md b/api-1/fhir-api/search-1/README.md index 6eeddd24..4b534b88 100644 --- a/api-1/fhir-api/search-1/README.md +++ b/api-1/fhir-api/search-1/README.md @@ -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" %} @@ -58,7 +56,7 @@ GET /Patient?name=Max&_elements=id, birthDAte ## Special Parameters -
ParameterTypeDescription
_contentFHIRFull text search by resource content
_elementsFHIR+Include or exclude specific resource elements
_explainGet query execution plan
_hasFHIR
_idFHIRSearch and sort by resource id
_ilikeILIKE search by resource content
_includeFHIRInclude referenced resources into result
_lastUpdatedFHIRSearch and sort by resource last modification date
_listFHIRSearch resources included into specific List
_profileFHIRSearch by resource profile
_resultChange result format
_revincludeFHIRInclude into result resources, which reference searched resources
_securityFHIR
_sortFHIRSort search results
_summaryFHIRInclude only summary elements
_tagFHIR
_textFHIRFull text search by resource narrative
_totalFHIRTurn on/off total count
_withAidboxInclude into result resources (compact way compared to _include and _revinclude)
+
ParameterTypeDescription
_contentFHIRFull text search by resource content
_elementsFHIR+Include or exclude specific resource elements
_explainGet query execution plan
_filterFHIRPerform an advanced search
_hasFHIR
_idFHIRSearch and sort by resource id
_ilikeILIKE search by resource content
_includeFHIRInclude referenced resources into result
_lastUpdatedFHIRSearch and sort by resource last modification date
_listFHIRSearch resources included into specific List
_profileFHIRSearch by resource profile
_resultChange result format
_revincludeFHIRInclude into result resources, which reference searched resources
_securityFHIR
_sortFHIRSort search results
_summaryFHIRInclude only summary elements
_tagFHIR
_textFHIRFull text search by resource narrative
_totalFHIRTurn on/off total count
_withAidboxInclude into result resources (compact way compared to _include and _revinclude)
## Search Parameters @@ -72,7 +70,7 @@ Depending on the value type, different modifiers can be applied. ## Supported modifiers -
ModifierTypesDescription
missingallTests whether the value in a resource is present (when the supplied parameter value is true) or absent (when the supplied parameter value is false)
textstring, token, reference, uriTests whether the textual value in a resource matches the supplied parameter value using basic string matching (begins with or is, case-insensitive)
belowuriTests whether the value in a resource is or is subsumed by the supplied parameter value (is-a, or hierarchical relationships)
containsstringCase insensitive, partial match at start or end
ends, ewstringCase insensitive, partial match at end
exactstringNo partial matches, case sensitive
starts, swstringCase insensitive, partial match at start
btwdateSearch between two dates
identifierreferenceTests whether the Reference.identifier in a resource (rather than the Reference.reference) matches the supplied parameter value
notreference, token, uriReverses the code matching: returns all resources that do not have a matching item.
itokenCase insensitive, exact match of text associated with token or token itself
intokenTests whether the value in a resource is a member of the supplied parameter ValueSet
of-typetoken (only Identifier)Tests whether the Identifier value in a resource matches the supplied parameter value
iterate, reverse, logicaln/aSee _include
+
ModifierTypesDescription
missingallTests whether the value in a resource is present (when the supplied parameter value is true) or absent (when the supplied parameter value is false)
textstring, token, reference, uriTests whether the textual value in a resource matches the supplied parameter value using basic string matching (begins with or is, case-insensitive)
belowuriTests whether the value in a resource is or is subsumed by the supplied parameter value (is-a, or hierarchical relationships)
containsstringCase insensitive, partial match at start or end
ends, ewstringCase insensitive, partial match at end
exactstringNo partial matches, case sensitive
starts, swstringCase insensitive, partial match at start
btwdateSearch between two dates
identifierreferenceTests whether the Reference.identifier in a resource (rather than the Reference.reference) matches the supplied parameter value
notreference, token, uriReverses the code matching: returns all resources that do not have a matching item.
itokenCase insensitive, exact match of text associated with token or token itself
intokenTests whether the value in a resource is a member of the supplied parameter ValueSet
of-typetoken (only Identifier)Tests whether the Identifier value in a resource matches the supplied parameter value
iterate, reverse, logicaln/aSee _include
### Search with modifiers examples @@ -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