API Reference

Search or Get FHIR Resources

get
https://{instanceUrl}/fhir-provider//fhir/

Retrieves FHIR resources from the specified provider. Supports both individual resource retrieval and search operations based on the FHIR path and query parameters.

The request is proxied to the configured FHIR server with appropriate authentication headers.

Path Params
string
required

The ID of the FHIR provider to use. Can be either:

  • A UUID representing the provider ID
  • A provider name (legacy support - will just use the most recently updated provider with this name)
string
required

The FHIR resource path to operate on. This follows FHIR RESTful API conventions. Examples:

  • "Patient" (for resource type operations)
  • "Patient/123" (for specific resource operations)
  • "Patient/123/_history" (for history operations)
Query Params
query_parameters
object

FHIR-compliant query parameters for search operations. Supports standard FHIR search parameters including:

  • Resource-specific search parameters (e.g., name for Patient, status for Observation)
  • Common search parameters (_id, _lastUpdated, _tag, _profile, _security, _text, _content, _filter)
  • Result parameters (_count, _offset, _sort, _include, _revinclude, _summary, _elements)
  • Search prefixes for dates, numbers, quantities (eq, ne, gt, ge, lt, le, sa, eb, ap)
Headers
string

Optional header for on-behalf-of authentication. Used when making requests on behalf of another user or entity. Must be in the format: Patient/{uuid} or Practitioner/{uuid}

string

Optional header for FHIR provider authentication. Contains credentials in the format {fhir_provider_id}:{oauth2_token}. Multiple FHIR provider integrations can be provided as comma-separated values.

Responses

Updated 4 months ago

Language
Credentials
Bearer
JWT
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 4 months ago