MediBridgeX
Sign InGet Started

Documentation

Everything developers need to integrate with the MediBridgeX platform.

API Reference

Browse the complete MediBridgeX API surface, organized by platform services and healthcare interoperability modules.

5 min read Reference v1

Overview

The MediBridgeX API is organized into logical groups that mirror the platform architecture. Each section contains endpoints related to a specific platform capability, from core FHIR data to administrative configuration.

Client
Auth
Platform
Service APIs
FHIR
HL7
Messaging
Projects

API Categories

4 endpoints

Authentication

Manage API keys and access tokens.

Open
6 endpoints

Organizations

Top-level tenant and billing management.

Open
5 endpoints

Projects

Isolate environments and credentials.

Open
145 endpoints

FHIR Gateway

Read and write clinical resources.

Open
COMING SOON
8 endpoints

HL7 Engine

Process legacy v2 messages.

Open
12 endpoints

Message Pipeline

Stream real-time healthcare events.

Open
COMING SOON
5 endpoints

Transformation Engine

Convert data formats dynamically.

Open
3 endpoints

Monitoring

Health checks and system metrics.

Open
2 endpoints

Audit Logs

HIPAA-compliant access trails.

Open
7 endpoints

Platform

Core infrastructure webhooks.

Open

Popular Endpoints

GET/fhir/Patient
Search and retrieve Patient resources.
GET/fhir/Observation
Fetch clinical observations and vitals.
POST/messages
Ingest a new HL7 or FHIR message payload.
GET/organizations
List all organizations you have access to.
GET/projects
List projects within your current organization scope.
GET/audit-logs
Query security and access logs.

Request Format

GET/fhir/Patient/12345
// Headers
Authorization: Bearer YOUR_API_KEY
Accept: application/fhir+json
Content-Type: application/fhir+json

Response Format

200 OKapplication/fhir+json
{
  "resourceType": "Patient",
  "id": "12345",
  "active": true,
  "name": [
    {
      "use": "official",
      "family": "Doe",
      "given": ["Jane"]
    }
  ]
}

HTTP Status Codes

200OK

Request succeeded.

Standard response for successful GET, PUT, or PATCH requests.

201Created

Resource created.

Standard response for successful POST requests.

204No Content

Success, no body.

Standard response for successful DELETE requests.

400Bad Request

Invalid input.

The request payload or parameters were malformed.

401Unauthorized

Invalid credentials.

Missing or invalid API key.

403Forbidden

Insufficient scope.

API key is valid but lacks permissions for the action.

404Not Found

Resource missing.

The requested endpoint or resource ID does not exist.

409Conflict

State conflict.

The request conflicts with current state (e.g., duplicate).

422Unprocessable

Validation failed.

The payload was well-formed but invalid semantically.

429Too Many Requests

Rate limited.

You have exceeded your API rate limit.

500Server Error

Platform error.

An internal issue on the MediBridgeX platform.

API Conventions

JSON

All API requests and responses must be standard JSON or FHIR JSON.

HTTPS

All API requests must be made over HTTPS. Plain HTTP is rejected.

REST

The API is designed using standard RESTful principles and verbs.

FHIR

Clinical endpoints adhere strictly to the HL7 FHIR R4 standard.

Pagination

List endpoints use cursor-based pagination via the `link` header.

Filtering

Resources can be filtered using standard query parameters.

Sorting

Sort results using the `_sort` parameter (e.g., `_sort=-updated`).

Versioning

The API is versioned via the URL path (e.g., `/v1/`).

Continue Exploring

FHIR Resources Sandbox SDKs