The Role and Structure of RESTful API in FHIR
RESTful API - FirestarterPro
Summary
In FHIR, a RESTful API is the standard HTTP interaction layer that defines how clients read, create, update, search, and delete resources on a server. It serves as the practical mechanism for exchanging FHIR data.
Details
FHIR is built upon REST conventions: resources are identified by URLs, interactions use standard HTTP methods (GET, POST, PUT, PATCH, DELETE), and responses carry standard HTTP status codes. A FHIR server exposes a base URL from which every resource type is reachable at a predictable endpoint pattern ([base]/[ResourceType]/[id]). The specification defines precise interactions that conformant servers must support: read (GET by id), search (GET filtered list), create (POST), update (PUT full replacement), patch (PATCH partial update), delete (DELETE), and history (GET past versions). Servers advertise their capabilities via a CapabilityStatement. While the RESTful model is dominant, FHIR resources can also be exchanged non-RESTfully (e.g., using Bundles for batch operations or bulk data exports). However, in practice, when practitioners refer to the “FHIR API,” they almost always mean this RESTful interaction layer because it forms the basis of patient access and payer-to-payer exchanges. Understanding the URL structure, HTTP method semantics, and CapabilityStatement is crucial for integrating with any FHIR server.
Original content copyright by respective publishers