Aidbox provides a Search API for all stored resources. Aidbox Search API is a superset of the FHIR Search API.

A base search request is composed of the list of pairs param = value:

GET [base]/fhir/[resourceType]?param=value&param=value&...

GET [base]/[resourceType]?param=value&param=value&...

Where param can be one of:

• ​Underscored parameter started with underscore, like _sort

• Name of search parameter​

• ​Chained parameter expression

• ​Dotted expression - started with .

Simple search by patient name:

GET /fhir/Patient?name=Max&_elements=id, birthDAte

GET /Patient?name=Max&_elements=id, birthDAte

Special Parameters

Search Parameters

Search defined in terms of "search parameters". SearchParameter is a meta-resource, which describes which part of the resource it is and how you can make it searchable.

Search parameter can be one of the following types:

Depending on the value type, different modifiers can be applied.

Common

• :missing

• :text — case insensitive, partial match of text & data associated with search parameter.

GET /fhir/Entity?description:missing=true
// For gender:missing=true,
// server will return all resources that
// don't have a value for the gender parameter. 

GET /Entity?description:missing=true
// For gender:missing=true,
// server will return all resources that
// don't have a value for the gender parameter.

// Search for any patient with [email protected] email
GET /fhir/Patient?email:text=[email protected].com
​
// Search for any patient with gmail or icloud email
GET /fhir/Patient?email:text=GMail.com,ICloud.com
​
// Search for any patient which have "fhir" in any of their contact info
GET /fhir/Patient?telecom:text=fhir

// Search for any patient with [email protected] email
GET /Patient?email:text=[email protected].com
​
// Search for any patient with gmail or icloud email
GET /Patient?email:text=GMail.com,ICloud.com
​
// Search for any patient which have "fhir" in any of their contact info
GET /Patient?telecom:text=fhir

Strings

• :exact — no partial matches, case sensitive;

• :contains — case insensitive, partial match at start or end.

Default behavior is case insensitive, partial match at start.

GET /fhir/Patient?name:exact=Alex

GET /Patient?name:exact=Alex

Token

• :not — reverses the code matching: returns all resources that do not have a matching item.

• :i — case insensitive, exact match of text associated with token or token itself.

• :in — the search parameter is a URI (relative or absolute) that identifies a value set, and the search parameter tests whether the coding is in the specified value set.

//Search for any patient with a gender that does not have the code "male"
//Note that for :not, the search does not return any resources that have a gen
GET /fhir/Patient?gender:not=male

//Search for any patient with a gender that does not have the code "male"
//Note that for :not, the search does not return any resources that have a gen
GET /Patient?gender:not=male

// Search for patient with email which is [email protected]
GET /fhir/Patient?email:i=[email protected].baz
// Note: this search won't find patient with emails like:
// [email protected]
// [email protected]

// Search for patient with email which is [email protected]
GET /Patient?email:i=[email protected].baz
// Note: this search won't find patient with emails like:
// [email protected]
// [email protected]

//Search for any condition that is in the institutions list of cardiac conditions
//Note: you must have Concept with valueset defined
​
GET /fhir/Condition?code:in=/ValueSet/cardiac-conditions

//Search for any condition that is in the institutions list of cardiac conditions
//Note: you must have Concept with valueset defined
​
GET /Condition?code:in=/ValueSet/cardiac-conditions

Reference

Reference describes the relationship between resources. Following options are available for filtering by reference:

Сoded element or identifier

GET /fhir/Patient?gender=female

GET /Patient?gender=female

[parameter]=[id]

[parameter]=[type]/[id]

For example, let's find all encounters related to a specified patient:

GET /fhir/Encounter?subject=patientid

GET /Encounter?subject=patientid

GET /fhir/Encounter?subject=Patient/patientid

GET /Encounter?subject=Patient/patientid

Prefixes

For Numbers, Dates, and Quantities (will be supported), we can use the following conditionals in a search:

• eq - equal (default)

• ne - non-equal

• lt - less than

• le - less or equal

• gt - greater than

• ge - greater or equal

GET /fhir/Patient?birthdate=gt1986-04-28

GET /Patient?birthdate=gt1986-04-28