FHIR Search Query Builder

The URL, and what each piece of it actually does.

Everything on this page runs in your browser. No request is sent anywhere - not to the server you name, and not to us. Identifiers you type stay on this page.

Joining parameters with an ampersand is not the hard part. The hard part is that FHIR search has defaults nobody remembers, and modifiers whose legality depends on the parameter's type - so a query that is subtly wrong is accepted, runs, and returns a plausible set. This page describes FHIR R4 as specified; which parameters a given server actually implements is in its CapabilityStatement, at /metadata, and that is the first thing to read when a search returns more than it should.

The search

Resource

Server root Whatever comes before the resource type. Not contacted.

Parameters

Include referenced resources

An include names the resource that holds the reference and the parameter that points along it - not the type you want back. _revinclude walks the same reference in reverse.

The response

_summary

_total

_sort

_count

_elements A hint the server may ignore.

GET

Easy to get subtly wrong

These hold whether or not this particular query got them wrong. They are the ones that produce a working query returning the wrong set.

← All tools