FHIR API Search

You can use the search functionality that’s built in to FHIR® to find data on the 1up FHIR Server. You can find data for both simple and complex use cases by running queries that use a RESTful syntax.

For more information about the FHIR search functionality, see Search in the HL7 FHIR Specification.

Limitations

Searches of the data in the 1up FHIR Server are subject to the following limitations.

Because Amazon API Gateway has changed how it processes special characters against REST, FHIR Search no longer supports the plain text pipe (vertical bar) character (|) for any GET request URL query string. Pipe characters must be URL-encoded in GET requests.

When you use FHIR search syntax, to include |, specify %7C in your request. 

<1upServerEndpoint>/Patient?identifier=<system>%7C<idvalue>

The FHIR Server supports the plain text pipe character (|) through POST search queries.

For example, the following cURL script is valid to use FHIR search syntax on a Patient.identifier, where the system/idvalue pair is passed in the request body.

curl -X POST -H '<1upServerEndpoint>/Patient/_search' -d 'identifier=<system>|<idvalue>'

You can also apply filters to your search queries by chaining conditions in the request body.

The following curl script searches for Patient resources based on the date that the resource was last changed.

curl -X POST -H '<1upServerEndpoint>/Patient/_search' -d 'identifier=<system>|<idvalue>' -d '_lastUpdated=gt2019'

Search Process

When you submit a FHIR search query, the following process occurs.

  1. The client sends a request for the data with this HTTP syntax:

    GET [baseUrl]/[resourceType]?[optional search parameters]

  2. The server returns a FHIR Bundle resource.

    A FHIR Bundle resource is a container resource that contains all of the matching search results of individual FHIR resources.

Search Options

The 1up FHIR Server supports the following FHIR Search options.

Search Parameters

Learn how to use FHIR API Search parameters to find data on the 1up FHIR Server.

Search Pagination

Learn how the 1up FHIR Server paginates search responses and how to get all the FHIR resources for large requests.

Search Sort

Learn how to sort the search results from the 1up FHIR Server.

Chained Search

Learn how to use chained search to traverse references within the context of your search query.

Search Included Resources

Learn how to include related resources in your search results.

Search Prefixes

Learn about the supported prefixes for numbers and dates that you can use in your search requests.

Search Modifiers

Learn how to include modifiers in your search query to refine your search results.