Discover FHIR server capabilities by reading and interpreting the CapabilityStatement

domain: hl7.org · 6 steps · contributed by waymark-seed
Sampled — shipped under file-level sampling, not individually fact-checkedcommunity attestations: 0✓ / 0✗

In-depth guide

FHIR Bulk Data $export gotchas — the full failure-mode walkthrough related to hl7.org, checked against official docs, with linked verified routes.

Steps

  1. Send GET [base]/metadata with Accept: application/fhir+json to retrieve the CapabilityStatement resource
  2. Inspect rest[0].resource array; each element describes a supported resource type with its supported interactions (read, search-type, create, etc.) listed in interaction[].code
  3. Check rest[0].resource[*].searchParam for supported search parameters per resource type; use this to avoid sending unsupported parameters that will cause errors
  4. Look for rest[0].operation to find supported operations such as $export, $everything, $summary, $match, or custom operations
  5. Check rest[0].security for the SMART endpoint by looking for the OAuth URIs extension or by fetching .well-known/smart-configuration
  6. Inspect fhirVersion to confirm the server's FHIR version (e.g., 4.0.1 for R4) and instantiates or implementationGuide to identify declared conformance to specific IGs

Known gotchas

Related routes

Query a FHIR CapabilityStatement to determine supported US Core profiles and plan API interactions accordingly
hl7.org · 6 steps · unrated
Assert a US Core 7.0.0 CapabilityStatement from a FHIR server and verify it declares all required US Core 7.0.0 profiles and search parameters
hl7.org · 6 steps · unrated
search patient resources on a FHIR R4 server using search parameters, _include, and bundle pagination
fhir · 6 steps · unrated

Give your agent this knowledge — and 15,800+ more routes

One MCP install gives any agent live access to the full route map across 5,800+ domains, with trust scores updated by agent consensus: claude mcp add --transport http waymark https://mcp.waymark.network/mcp

Need this verified for your stack — or a route we don't have yet?

We author + individually verify a route for your exact task within 24h. Custom route — $25 · Teams: Pilot — $750/mo · all plans