REST API & Developer Access FAQ.

A standard HTTP interface for all Redix conversion and compliance tools. Works with any language — Python, C#, Java, Node.js, curl, Go, Ruby, PHP, Rust, VB.NET.

Current version: /api/v2. Authentication uses the X-API-Key header.

• POST /api/v2/convert/smart — auto-detect and convert any supported format
• POST /api/v2/convert/hl7-to-fhir — HL7 v2.x to FHIR R4
• POST /api/v2/convert/cda-to-fhir — CDA to FHIR R4
• POST /api/v2/convert/file-upload — generic file conversion via Redix Engine

HIPAA X12 endpoints:

• /api/v2/hipaa-to-fhir/* — X12 EDI to FHIR R4 (837, 835, 278, 270/271, 276/277, 834, 820)
• /api/v2/fhir-to-hipaa/* — FHIR R4 to X12 EDI

• Da Vinci PAS — /api/pas/Claim/$submit, $inquire, $cancel
• Patient Access — /api/patient/Claim, ClaimResponse, Coverage, ExplanationOfBenefit
• Provider Access — /api/provider/Patient, Claim, ClaimResponse
• Payer-to-Payer — /api/payer/Consent, Patient, Coverage, bulk $export
• CRD — /cds-services/order-sign-crd
• DTR — /fhir/Questionnaire, /fhir/QuestionnaireResponse
• RMap to FHIR PAS — /api/v2/rmap-to-fhir/278-request

Official SDKs:

• Python — pip install redix-client (Python 3.8+, available on PyPI)
• Node.js — npm install redix-client (Node 18+, available on npm)

Documented examples:

• C# / .NET — HttpClient + X-API-Key (.NET 6+, VB.NET supported)
• Java — java.net.http.HttpClient (Java 11+)
• curl / CLI — Bash and PowerShell

Any language with HTTP support works via the standard multipart/form-data interface — Go, Ruby, PHP, Rust, and others.

API key via X-API-Key header.

Demo keys (public sandbox, rate-limited):

• demo-key-12345 — full access
• test-key-67890 — full access
• readonly-key-11111 — GET only

Production: Customer-managed keys on customer infrastructure. CMS compliance APIs support OAuth 2.0 and SMART on FHIR for production deployments.

JSON with standard fields:

• success — boolean
• conversion_id — unique identifier
• converter — which converter was used
• processing_time_ms — conversion time in milliseconds
• resource_count — number of FHIR resources generated
• fhir_bundle — the FHIR R4 Bundle output
• warnings — array of any conversion warnings

HTTP status codes: 200 Success, 400 Bad Request, 401 Unauthorized, 422 Unprocessable Entity (validation error), 500 Server Error.

Configurable per deployment. Defaults:

• Conversion APIs: 10 requests/second
• Admin APIs: 5 requests/second
• Health checks: unlimited

The public demo key is additionally rate-limited for fair use.

• On-premises — your data center
• Docker — container deployment
• Kubernetes — orchestration at scale
• Private Cloud — AWS, Azure, GCP in your VPC

PHI never leaves your environment. TLS 1.2+ encryption for all traffic.

Base URL options: localhost:8080 (dev), https://your-domain.com via Nginx (production), https://localhost:8444 with native SSL.

• Swagger UI at /docs — interactive with "Try it out" buttons
• ReDoc at /redoc — alternative documentation view
• OpenAPI spec at /openapi.json — machine-readable specification
• Redix REST API Guide — PDF, updated January 2026

Three paths:

• Try the Sandbox — test API and 10 conversion tools with sample data. No installation needed.
• Request Evaluation — get the engine, API server, and SDKs for your infrastructure.
• Deploy Locally — on-premises, Docker, or private cloud. PHI stays in your environment.