FHIR Search

The FHIR Search page allows authorized users to perform basic FHIR searches for all types of resources.

Viewing the FHIR Search Page

When logged in, you can find the FHIR search page in the main menu under FHIR -> Search.

1. Select the desired endpoint.
2. Select a resource.
3. (Optionally) Enter search parameters.
4. (Optionally) Enter other search options, such as results per page and sort order.
5. Click “Search”.

For example, the following search using the Patient resource and a family name search parameter is equivalent to a search by last name in the Patients Dashboard.

Entering Search Parameters

You may select multiple search parameters. The list of available search parameters mirrors the list of resource elements.

Omit all parameters to find all resources of the specified type.

Search parameters support different qualifiers depending on type. For example, given name (a string) supports things like “starts with” and “contains”, while gender (a fixed list of possible values) searches for a value “in” the list. You can also search for records with the value “missing” or “present”.

Viewing Search Results

The results of the search appear in the right panel. The default result format is a tree view, where you can expand and collapse sections of the record to drill down into the details. You can also select JSON or XML output formats using the “Result format” option at the bottom of the search parameters.

Advanced Searching

Several advanced search options are available.

Sort Order

You can configure the sort order. The list of available fields to sort on varies by resource type. Check the “Descending” box to sort in descending order.

Summary and Count

When the “Summary” option is set to “Yes”, only a subset of elements (based on the HL7 Summary Parameter) are included in the resulting resources. The summary also lets you retrieve a count of resources instead of the resources themselves.

You can also see a count of resources by checking the “Enable Total” checkbox. The total will appear near the pagination information.

Selecting Elements

By default, the results include all resource elements. You can limit which elements are returned using the “Elements” selector.

Including Related Resources

Select additional resource types under “Includes” to include related resources. For example, by selecting AllergyIntolerance:patient, the search not only includes the matching patient record, but also AllergyIntolerance records associated with that patient.