FHIR® API

We support notifications, queries, writeback, and Bulk Data Access messages with the Redox FHIR® API. Learn more about exchanging data via FHIR®.

For technical specs, check out the schemas for:

  • FHIR® resources (contains schemas for both queries and writebacks)
    FHIR spec examples

    We don't currently recommend copying and pasting examples from our FHIR® specs for your API calls. Our specs show the shape and possibility of each FHIR® resource; they're not code for real-time API calls.

Each schema contains a list of supported interactions, operations, or events.

FHIR® request URLs

All FHIR® request URLs start with this base: https://api.redoxengine.com/fhir/R4/{{destination-slug}}/{{environment-type}}.

How to fill out the base URL

The FHIR® base URL tells Redox where to send your message.

  • {{destination-slug}}: Represents your connection. This is often the Redox organization name for your connection. Your Redox Implementation Manager provides this value.
  • {{environment-type}}: Indicates the type of environment you’re querying or writing data to. Set this to Development, Staging, or Production.

Append the path for the FHIR® interaction or operation you want to use to the base URL. For example, to retrieve a Patient resource with ID 123, you could use a URL like: https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Patient/123.

Notes about FHIR URLs
  • Case sensitivity: Request URLs are case sensitive. Environment types are capitalized (e.g., Staging), and resource names are Pascal case (e.g., AllergyIntolerance).
  • Resource IDs: These aren’t static when you query via Redox, so don’t plan to reuse them to retrieve the same data later. Learn how to handle FHIR® identifiers.

Download dev tools

Explore Redox APIs with developer test tools.

Test with the Redox FHIR sandbox

Explore and use Redox FHIR sandbox data to test your integration.

Popular articles

FHIR search

Learn how to perform FHIR searches like a pro.

Redox FHIR API

Learn more about the basics of the Redox FHIR API, including FHIR definitions and Redox capabilities via FHIR.

FHIR glossary

Learn basic definitions of the FHIR interoperability world.

FHIR® is a registered trademark of Health Level Seven International (HL7) and is used with the permission of HL7. Use of this trademark does not constitute an endorsement of products/services by HL7®.