Overview

A System Integration to b.well's FHIR Server provides direct, system-level access to b.well's FHIR compliant data store for server-to-server integrations. This integration option is ideal for backend systems, data analytics workflows, or applications that need direct FHIR API access outside of an end-user context.

Choose the b.well FHIR Server when you:

Have server-to-server integration requirements
Need direct FHIR API access for data analytics or reporting
Want to retrieve health data for multiple patients or system-level operations
Are building backend services that operate outside end-user application contexts

Note: This integration differs from the Application APIs, which operate in an end-user context and data is limited to that particular end-user.

Integration At a Glance

Integrating with the b.well FHIR Server follows this pattern:

Request account credentials from b.well (service account for API access or user account for Web UI)
Authenticate using system authentication (see System Authentication)
Access FHIR Server endpoints using standard FHIR R4 REST operations
Query resources individually, use $everything for bulk retrieval, or generate International Patient Summaries

The FHIR Server supports standard FHIR R4 operations including resource retrieval, search parameters, paging, and streaming. See the FHIR Server GitHub Repository for complete technical documentation and the Cheatsheet for quick reference.

Account Setup Required
Access to the b.well FHIR Server requires either a service account (for API access) or user account (for Web UI access). Contact b.well to provision your account credentials.

FHIR Server Account Types

Service Account
System-level authentication for programmatic API access. Service accounts use OAuth 2.0 Client Credentials or API key authentication for server-to-server workflows.

User Account
View-only access to the FHIR Server Web UI for testing and troubleshooting. User accounts authenticate with username/password credentials (b.well is the identity provider).

See the FHIR Server Web UI guide for details on navigating the Web UI interface.

FHIR API Query Examples

Example	Description
Retrieving Individual FHIR Resources	Query specific FHIR resources by ID or search parameters using standard FHIR REST operations
Using $everything	Bulk retrieval of complete patient records including all related clinical and non-clinical resources
Retrieving the IPS	Generate International Patient Summary documents for care coordination and patient data exchange
Paging vs. Streaming	Choose between paginated results or streaming responses for large data sets

For detailed implementation guides, API specifications, and code examples, see the FHIR Server GitHub Repository.