Documentation Hub
Everything you need to integrate with APEX Nexus — API reference, FHIR guides, auth, webhooks, compliance, and 663+ production endpoints.
663+
Production Routes
355+
FHIR Resource Types
15
OpenAPI Specs
17
Integration Guides
3
SDK Languages
5
Compliance
Start here
Getting Started
Partner account, credentials, first API call
API Reference
15 OpenAPI specs with Try-it-out
Integration Guides
17 step-by-step workflows
Sandbox
Test against sandbox.api.parkerapex.com
Scope Reference
OAuth, SMART, and API key scopes
FHIR R4 Reference
Live CapabilityStatement & REST patterns
Webhooks & Events
13 event types with payload schemas
API Keys & OAuth
Self-service tokens and client registration
Changelog
API and portal release notes
Rate Limits & SLA
Per-product tiers and uptime guarantees
API Environments
Production
https://api.parkerapex.comLive clinical and partner traffic — OAuth required on all FHIR writes.
Sandbox
https://sandbox.api.parkerapex.comSynthetic data, relaxed rate limits, same OpenAPI contracts.
FHIR Data Lake
https://lake.parkerapex.com/fhir/R4HAPI R4 longitudinal store — bulk export and GPID-stamped reads.
Popular integration guides
Step-by-step workflows for common integrations
Onboarding
Getting Started
Create a partner account, issue credentials, and make your first authenticated API call.
5 min
FHIR
Your First FHIR Read
Retrieve FHIR R4 metadata and read a Patient resource with OAuth bearer auth.
8 min
Authentication
Register an OAuth Client
Self-service OAuth 2.0 client registration for SMART on FHIR and machine-to-machine integrations.
6 min
Prime
Prime Wearable Ingest
Send vendor telemetry to Prime, normalize to FHIR Observations, and verify ingest status.
10 min
Authentication
API Keys & Scopes
Understand bearer token scopes, least-privilege access, and credential rotation.
4 min
Integration
Configure Event Webhooks
Receive pipeline, ingest, and partner lifecycle events at your HTTPS endpoint.
7 min
Full documentation catalog
API products, FHIR interop, identity, compliance, and platform architecture.
API Reference
Interactive API Reference
15 OpenAPI 3.0 specs — Swagger Try-it-out, YAML download, Postman
FHIR R4 API Reference
Live CapabilityStatement, REST patterns, bulk $export, SMART scopes
Scope Reference
Complete OAuth, SMART on FHIR, and API key scope catalog with endpoints
APEX Nexus Platform
Flagship EHR — FHIR R4, mobile, semantic layer, bulk export, 663+ routes
Full Route Catalog
Partner sign-in required — search 663 routes by method and domain
FHIR R4 Resource Catalog
355+ resource types, SMART on FHIR, US Core profiles
FHIR Data Lake
HAPI R4 store, ingest pipeline, quality metrics, lineage, GPID master
Postman Collections
15 pre-built collections — import and set access_token
SDK Generator Links
OpenAPI Generator deep links for TypeScript, Python, and Java per spec
Integration Guides
Getting Started
Partner account, credentials, and your first authenticated API call
Build on APEX Nexus
Platform architecture, data domains, auth, and route catalog
Your First FHIR Read
CapabilityStatement, OAuth bearer token, Patient search by GPID
Register an OAuth Client
Self-service OAuth 2.0 for SMART on FHIR and M2M integrations
Prime Wearable Ingest
Vendor telemetry → FHIR Observations with prime.ingest.write scope
Configure Event Webhooks
HTTPS endpoints, signature verification, delivery monitoring
Sightline Vision Exam Workflow
Exam sessions, refraction capture, optical fulfillment REST
Odonto Chart & Procedure Posting
Odontogram, treatment plans, CDT procedure posting
Bulk FHIR Export ($export)
SMART Backend Services bulk export, async polling, NDJSON download
All Integration Guides
17 guides across onboarding, FHIR, Nexus, auth, and Prime
Identity & Security
GPID Identity Resolution
Golden Record patient identity, SHA-256 matching, merge/split lifecycle
GPID Boundary Contract
Required X-Apex-Actor-GPID headers, enforcement rules, valid formats
Authentication & OAuth 2.0
OAuth, SMART on FHIR, JWT, MFA, RBAC, session management
API Keys & Scopes
Least-privilege bearer tokens, scope catalog, rotation policy
SMART Health Cards & Links
VCI-compliant verification, SHL generation, credential management
Compliance Frameworks
HIPAA, SOC 2 Type II, HITRUST CSF, ISO 27001, GDPR mappings
Plexus IAM
Enterprise identity, RBAC, tenant provisioning, audit trail
Platform Services
Apex Sightline (Vision EHR)
Refraction, diagnostics, VisionPrescription, optical fulfillment REST
Apex Odonto (Dental EHR)
Odontogram, treatment plans, CDT procedures, lab orders, imaging
Prime Wearables API
Oura, WHOOP, Garmin, Apple Health — telemetry → FHIR Observations
Horizon Population Health
NL-to-SQL, risk stratification, quality measures, care gaps
Catalyst Genomics
Variant calling, biomarkers, bioinformatics pipeline tracking
Beacon Document Ingest
PDF/FHIR upload, virus scanning, SMART Health Card verification
Velocity RCM
Claims submission, denials, AR aging, payer operations
Ledger & FedNow
Health Vault, medical credit, FedNow real-time payments
Integration & Ecosystem
CMS Health Tech Ecosystem
Partner onboarding wizard, token management, OAuth registration
TEFCA Gateway
QHIN exchange via KONZA Health — XCPD, XCA, network directory (OpenAPI v1)
TEFCA / KONZA Integration Guide
Outbound XCPD/XCA through Parker's designated QHIN partner KONZA Health
Webhooks & Event Catalog
18 event types with HMAC signing spec, retry policy, and idempotency
Rate Limits & Headers
X-RateLimit-* headers, HTTP 429 handling, per-product SLA tiers
Partner Certification
Go-live checklist — sandbox, security, production, and operations
SDK Catalog
TypeScript, Python, Java — FHIR R4 client libraries with GPID helpers
Sandbox Test Environment
sandbox.api.parkerapex.com — synthetic data, same OpenAPI contracts
Pipeline Monitor
Per-partner sync rates, latency, data quality, webhook delivery
Operations & Trust
Rate Limits & SLA
Per-product tiers, burst limits, X-RateLimit headers, 429 handling
System Status
Live health probes for production API, FHIR, OAuth, and lake endpoints
Changelog
API and developer portal release notes, breaking change notices
Deprecation Policy
90-day notice, Sunset headers, deprecated endpoint registry
Nexus Architecture Overview
Domain map, layers, and partner-safe architecture references
Security & Auth Reference
Token lifetimes, scope matrix, tenant isolation, audit logging
Legal & Compliance Hub
BAA, DPA, data retention, subprocessors, regulatory attestations