HL7 FHIR API
Open standard RESTful API specification for exchanging healthcare data (patients, observations, medications, conditions) across EHR systems using JSON or XML resources.
Score Breakdown
⚙ Agent Friendliness
🔒 Security
SMART on FHIR provides fine-grained patient/user/system scopes. PHI handling requires HIPAA BAA with the server operator. TLS 1.2+ required by ONC certification.
⚡ Reliability
Best When
Your agent needs vendor-neutral access to structured clinical data and the target system exposes a certified FHIR R4 endpoint.
Avoid When
The target health system only supports HL7 v2 or proprietary EHR APIs and has no FHIR facade.
Use Cases
- • Query patient demographics, allergies, and medications from any FHIR-compliant EHR
- • Aggregate clinical observations (vitals, lab results) across multiple provider systems
- • Sync care plans and immunization records between payer and provider portals
- • Trigger alerts when new diagnostic reports or conditions are written to a patient record
- • Build longitudinal patient timelines by fetching and correlating FHIR resource bundles
Not For
- • Real-time surgical telemetry or device streaming (use HL7 FHIR Subscriptions or dedicated device APIs)
- • Legacy HL7 v2 message routing — requires a separate integration engine
- • Direct consumer app data without an underlying FHIR server implementation
Interface
Authentication
SMART on FHIR (OAuth2 profile) is the standard auth layer; specific scopes follow patient/*.read and user/*.read conventions. Implementation varies per vendor.
Pricing
FHIR is a royalty-free open standard. Cost is incurred at the server/infrastructure layer, not the spec itself.
Agent Metadata
Known Gotchas
- ⚠ FHIR is a spec, not a product — behavior varies significantly across EHR vendor implementations of the same endpoint
- ⚠ SMART on FHIR OAuth2 launch sequences (EHR launch vs standalone launch) require different flows that agents must detect and handle
- ⚠ Paging via Bundle.link[relation=next] must be followed to retrieve complete result sets; agents that ignore paging will silently miss data
- ⚠ Date/time fields use FHIR dateTime partial precision (e.g., '2024-01' is valid) which can break ISO 8601 parsers expecting full timestamps
- ⚠ Resource versioning and conditional updates use ETags/If-Match headers — agents that skip these may overwrite concurrent changes
Alternatives
Full Evaluation Report
Detailed scoring breakdown, competitive positioning, security analysis, and improvement recommendations for HL7 FHIR API.
Scores are editorial opinions as of 2026-03-06.