Supported FHIR Interactions and Operations

General Support Notes

Keep in mind that a FHIR server using or extending the Resource Repository:

• Does not support searching across multiple resource types across compartments. For example GET [base]?_id=1 is not supported.

• Does support the use of the wildcard character (*) to search across multiple resource types within a compartment. For example: GET [base]/Patient/100000001/* is supported. Within a compartment, the search can use the wildcard in conjunction with any search parameters common to all the resource types which the search is targeting. This is especially useful if you use the _type parameter. For example: GET [base]/Patient/100000001/*?status=final&_type=Observation,DiagnosticReport is supported because both the Observation and DiagnosticReport resource type include the status element.

  Note:

  The wildcard syntax provides a different result than the $everything operation. GET [base]/Patient/100000001/* returns any and all resources associated with the specified Patient—including, for example, a Patient’s DiagnosticReport resources. By contrast, GET [base]/Patient/100000001/$everything returns all resources associated with the Patient resource as well as resources associated with those resources. Compared with the previous search, this search would also include Practitioner resources associated with the Patient’s DiagnosticReport resources.

Search Parameter Types

Each search parameter has a search parameter typeOpens in a new tab that determines how the parameter behaves.

* For canonical references, chained search is not supported. The use of the search result parameters _include and _revinclude for canonical references is also not supported.

Parameters

The following summarizes FHIR server support for standard search parametersOpens in a new tab when retrieving resources from the Resource Repository.

Modifiers

ModifiersOpens in a new tab can be added to the end of a parameter to affect the results of the search.

Prefixes

When using search parameters of type number, date, and quantity, you can add a prefixOpens in a new tab to the parameter’s value to affect what resources match the search. For example, [parameter]=le100 returns values that are less than or equal to 100.

Search Result Parameters

Search result parametersOpens in a new tab help manage the resources returned by a search.

Recursive Behavior of the _type Operation Query Parameter for $everything

When a list of resource types is provided in the _type query parameter for the $everything operation, the compartment search will return only resources of the type listed. Recursive resource reference retrieval in the compartment will skip over references to resource types that are not specified in the _types parameter. Some examples illustrate how the _type query parameter for $everything operates on the PatientOpens in a new tab compartment:

1. /Patient/123/$everything?_type=DiagnosticReport,Observation — returns DiagnosticReport and Observation resources but not the Patient resource.

2. /Patient/123/$everything?_type=Observation — returns the patient's Observation resources, even though the referring DiagnosticReport resources are not included, because Observation is also in the Patient compartment.

3. /Patient/123/$everything?_type=Practitioner — returns nothing. Practitioner is not in the Patient compartment, and no other resource type that could refer to Practitioner was specified.

4. /Patient/123/$everything?_type=Patient,DiagnosticReport,Practitioner — returns the Patient resource, all of the DiagnosticReport resources, and only the Practitioner resources directly referred to by the returned DiagnosticReport resources.