Redix CMS-0057-F API Documentation

API reference for the Redix CMS-0057-F Prior Authorization Suite

Overview

The Redix CMS-0057-F Prior Authorization Suite covers the four API areas of the CMS Interoperability and Prior Authorization Final Rule. Built on the proven Redix AnyToAny Conversion Engine, it converts X12 278 and RMap formats to Da Vinci PAS FHIR, with response conversion back to X12 278, and provides demonstration endpoints for the Patient Access, Provider Access and Payer-to-Payer APIs. Production deployment and integration with your systems are scoped per customer.

CMS-0057-F Timeline
Jan 1, 2026: Operational rules begin (72-hour expedited and 7-day standard decisions, with QHP issuers on the FFEs excluded from these timeframes; specific denial reasons)
Mar 31, 2026: First annual public reporting of prior authorization metrics (for example, approval and denial rates and decision times)
Jan 1, 2027: API requirements generally begin; exact timing depends on payer category

Compliance Responsibility Model
CMS-0057-F API requirements apply to impacted payers (Medicare Advantage organizations, Medicaid and CHIP programs and managed care plans, and QHP issuers on the FFEs). All four APIs are payer obligations. Providers are clients/users of these APIs, not hosts. This platform is designed for payer deployment, with optional provider-side integration patterns (customer-implemented) for EHR/RCM workflows. View Platform Overview →

What's Included

Component Description Base Path
Patient Access API Members access PA history, coverage, EOBs /api/patient
Provider Access API Shares patient data with eligible providers; includes a Redix-specific demo PA submission route /api/provider
Payer-to-Payer API Consent-based data exchange between plans /api/payer
Da Vinci PAS API $submit and $inquire (Da Vinci PAS operations); Redix demo endpoints listed separately /api/pas
X12 278 Conversion X12 278 → FHIR PAS (Response → X12 also supported) /api/v2/hipaa-to-fhir
RMap 278 Conversion Simplified RMap format to FHIR PAS /api/v2/hipaa-to-fhir (format detected by payload signature: X12 typically starts with ISA, RMap starts with RMP*)

Technical Specifications

Specification Value
FHIR Version R4 (4.0.1)
PAS Profile Da Vinci PAS 2.0.1 (declared by the service); tested sample X12 278 to FHIR output also passed 2.1.0 validation
US Core 3.1.1 Profiles
X12 Version 005010X217 (278)
Deployment On-premises and Docker for the conversion services; Kubernetes assessed per customer
Database SQLite in the demo; customer database options assessed per deployment

Authentication

Authentication is deployment-specific. The demo uses an API key. Production deployments use identity and access infrastructure agreed for the deployment; an API key alone does not establish production PAS security. The public demo key accepts registered Redix samples only; customer-supported, de-identified input requires a scoped evaluation key.

HTTP Header (Demo)
X-API-Key: demo-key-12345

Demo Authentication

For testing and evaluation with the public demo sandbox:

Environment Auth Method Notes
Demo X-API-Key: demo-key-12345 Public demo key, rate-limited, registered Redix samples only
Production Agreed for the deployment Identity and access infrastructure agreed for the deployment

Quick Start

For current sample conversions, use the public X12 278 / FHIR converter or the Swagger API explorer. The public demo key accepts registered Redix samples only. Testing your own supported, de-identified files requires an evaluation key. Do not upload production PHI. Copy-and-run examples will be restored after public-endpoint testing.

Patient Access API

Allows patients/members to access their prior authorization history, coverage information, and Explanation of Benefits through FHIR R4 endpoints.

Endpoints

GET /api/patient/Claim

Search patient's prior authorization requests

GET /api/patient/Claim/{id}

Get specific PA claim by ID

GET /api/patient/ClaimResponse

Search PA decisions/responses

GET /api/patient/Coverage

Search patient's insurance coverage

GET /api/patient/ExplanationOfBenefit

Search Explanation of Benefit records

GET /api/patient/Provenance

Search provenance (audit) records

Search Parameters

Parameter Type Example
patient reference Patient/patient-001
status token active
_include_provenance boolean true

Provider Access API

The CMS Provider Access API shares patient data with eligible providers. PA submission belongs to the Prior Authorization API; any /api/provider/Claim/$submit route here is a Redix-specific demo route, not the CMS Provider Access requirement.

Payer-Hosted: These endpoints are hosted by the payer (or payer's delegate). Providers are clients of this API, not hosts.

Endpoints

GET /api/provider/Patient

Search patients

GET /api/provider/Practitioner

Search practitioners by NPI

GET /api/provider/Organization

Search organizations

POST /api/provider/Claim/$submit

Submit prior authorization request

GET /api/provider/ClaimResponse

Search PA responses

Payer-to-Payer API

Supports consent-driven data exchange when members switch health plans. Includes bulk FHIR export capabilities.

Endpoints

GET /api/payer/Consent

Search member consents

POST /api/payer/Consent

Register new consent for data exchange

POST /api/payer/Group/{id}/$export

Initiate bulk FHIR export for member

GET /api/payer/export-status/{job_id}

Check bulk export status

Da Vinci PAS API

Da Vinci Prior Authorization Support (PAS) operations $submit and $inquire, with X12 278 conversion. The service declares PAS 2.0.1. In the demonstration, authorization decisions are simulated.

Operations

POST /api/pas/Claim/$submit

Submit new prior authorization request

POST /api/pas/Claim/$inquire

Check status of existing PA

GET /api/pas/metadata

FHIR CapabilityStatement

Redix demo endpoints (not Da Vinci PAS operations)

These shortcuts exist in the Redix demonstration only. In the Da Vinci PAS guide, updates and cancellations are sent through $submit: updates use the claim-update profile and cancellations use the infoCancelled extension.

POST /api/pas/Claim/$update

Demo only: update a pending request with additional information

POST /api/pas/Claim/$cancel

Demo only: cancel a request

Decision Timeline Requirements

CMS-0057-F sets response timeframes for prior authorization decisions (QHP issuers on the FFEs are excluded). The Redix PAS API carries the request priority and decision fields these timeframes rely on; meeting them depends on the payer’s review process.

Request Type Decision Deadline FHIR Field Notes
Expedited/Urgent 72 hours Claim.priority = urgent For urgent clinical situations
Standard 7 calendar days Claim.priority = normal All non-urgent requests

Pended Requests: When a PA is pended for additional information, payers must communicate the specific reason and required documentation. Requests for additional information and any permitted extensions must follow the rules applicable to the payer and request; do not assume an automatic pause.

PA Status Mapping

ClaimResponse.outcome describes processing, not the clinical authorization decision. Map approval, denial, pending and cancellation using the applicable PAS profile and verified transaction mapping.

X12 278 to FHIR Conversion

Convert X12 278 Prior Authorization transactions to Da Vinci PAS FHIR Bundles using the Redix AnyToAny Conversion Engine.

Endpoints

POST /api/v2/hipaa-to-fhir/278-request

Convert X12 278 Request to FHIR

POST /api/v2/hipaa-to-fhir/278-response

Convert X12 278 Response to FHIR

RMap 278 to FHIR Conversion

RMap (Redix Mapping) is a simplified, human-readable format that converts directly to Da Vinci PAS FHIR Bundles. Ideal for organizations without X12 278 infrastructure.

Why Use RMap?
No X12 expertise required. Generate RMap from any database or spreadsheet. One record per line, asterisk-delimited fields.

RMap 278 Format

Illustrative fragment of the format (not an executable example).

rmap_278_request.rmap
# RMap 278 PA Request - Simple, readable format
RMP*RMap_5_278REQ*20251215*0900*278_to_FHIR.map
TR1**PA2025001*20251215*0900**13
UR0*2*ACME HEALTH INS****PI*123456789*1P*1*WILSON*SARAH***34*1234567890
SB0*JOHNSON*ROBERT***19550315*M*MI*XYZ123456789
PE0*SC*I*3*11*B*********Y**27447*1234567890
DX0*BF*M17.11*20251201
SV0*HS*I*1****20251220**I**HC*27447********UN*1
EOF

Record Types

Record Purpose FHIR Resource
RMP Header (version, date) -
TR1 Transaction control Claim.identifier
UR0 Payer & requester info Organization, Practitioner
SB0 Subscriber/patient Patient
PE0 Service/event details Claim.item
DX0 Diagnosis codes Condition
SV0 Service lines Claim.item

See the included samples/RMAP_278_STRUCTURE.md for complete field-by-field documentation.

FHIR Response to X12 Conversion

Convert Da Vinci PAS FHIR ClaimResponse back to X12 278 Response format for legacy system integration.

POST /api/v2/fhir-to-hipaa/278-response

Convert FHIR ClaimResponse to X12 278 Response

Note: Currently supported: FHIR ClaimResponse → X12 278 Response. Additional conversion paths depend on customer requirements.

Attachment Handling

The Da Vinci PAS specification supports clinical documentation attachments in multiple formats. CMS-0057-F emphasizes electronic clinical data exchange.

Supported Attachment Formats

Format MIME Type Use Case
C-CDA Documents application/xml Structured clinical summaries
FHIR DocumentReference application/fhir+json Native FHIR documents
PDF Documents application/pdf Scanned records, letters of necessity

PWK Segment Mapping: When converting X12 278 with PWK (Paperwork) segments, attachments are automatically mapped to FHIR DocumentReference resources.

Provenance Tracking

Redix conversion output includes FHIR Provenance resources that record where each resource came from. CMS-0057-F does not name Provenance as a requirement; access and event audit logging, retention and monitoring are defined for each deployment.

Provenance Includes

  • Target - Reference to the resource created/modified
  • Recorded - Timestamp of the operation
  • Agent - Who performed the action
  • Entity - Source data reference (e.g., X12 278 input)
  • Activity - Type of operation performed

Error Handling

PAS and FHIR API errors are generally returned as FHIR OperationOutcome resources. On the demo conversion endpoints, authentication, sample-policy and rate-limit responses come from the demo gateway as JSON error messages.

Status Meaning
400 Bad Request - Invalid input data
401 Unauthorized - Missing API key
403 Forbidden - Invalid API key, an evaluation key required (public demo key with an unregistered input), or key out of scope
404 Not Found - Resource doesn't exist
422 Unprocessable - Validation failed
429 Too Many Requests - Demo rate limits (request spacing and daily limit)

Sample Data

The suite includes pre-loaded sample data for testing:

  • 5 Patients
  • 3 Practitioners
  • 4 Organizations (providers and payers)
  • 14 Claims (PA requests)
  • 4 ClaimResponses (PA decisions)
  • 3 Coverages
  • 3 Consents
  • 2 ExplanationOfBenefits
  • 14 Provenance records

Included Files

File Description
samples/rmap_278_request_sample.rmap Sample RMap PA request (TKA procedure)
samples/rmap_278_response_sample.rmap Sample RMap PA response (approved)
samples/RMAP_278_STRUCTURE.md Complete RMap format documentation

Conformance Testing

ONC's Inferno test platform is widely used for FHIR conformance testing. Da Vinci PAS test kits are available, and a deployment can be tested against them. Redix does not currently publish Inferno test results.

Available Test Suites

Test Kit Version Purpose
Da Vinci PAS 2.0.1 (STU 2); tested sample output also passed 2.1.0 (STU 2.1) validation Prior Authorization Support
US Core v3.1.1 Core FHIR profiles
Patient Access Current Patient API conformance

Running Inferno Tests

  1. Go to inferno.healthit.gov/test-kits/davinci-pas/
  2. Select "Server Suite" (tests your PAS server)
  3. Choose the authentication method supported by your deployment (for example, OAuth through the identity provider agreed for the deployment, or the API key for the demo)
  4. Enter your server URL: https://your-server/api/pas
  5. Run tests and review results

Conformance Statement: The Redix PAS API follows the Da Vinci PAS Implementation Guide (the service declares 2.0.1). The tested sample conversion output passed validation against the PAS 2.0.1 and 2.1.0 profiles with the HL7 FHIR Validator; this does not establish that every input produces valid output. The evidence is available during evaluation. No formal conformance certification is claimed.

Validation scope

Evidence currently covers the identified sample conversion outputs; full server conformance and Must Support coverage are not established by those results.

Support

Resource Contact
Technical Support support@redix.com
Sales Inquiries sales@redix.com
Phone (888) 850-8088
Live Demo demo.redix.com/docs

Need Help?
Contact our team for implementation assistance, custom integration support, or CMS-0057-F implementation consulting.

Next Steps