This page serves as the central entry point for onyxOS API documentation, directing developers, payers, and providers to detailed API guides based on their role.

OnyxOS Developer API Documentation

Topic Description
Background CMS set rules that require health plans to follow HL7 standards so patients can easily access and share their health data.
Accessing the APIs Access to Patient Access APIs is controlled through app registration and OAuth 2.0 / SMART on FHIR authorization to protect member data.
onyxOS, the Interoperability Rule and FHIR Implementation Guides onyxOS converts FHIR Implementation Guides and Capability Statements into APIs and provides supporting resources to meet CMS interoperability requirements.
└─ Implementation Guides For developers who are not familiar with HL7 FHIR Implementation Guides (IGs). An IG provides detailed information on data structures for resource profiles.
└─ Capability Statements Server Capability Statements define the data profiles, operations, access methods and search operations that are supported by the server.
└─ Swagger Files The swagger files enable developers to better understand the server interactions.
└─ Postman Collection Postman collections for testing onyxOS APIs

OnyxOS Payer API Documentation

Topic Description
Background Guidance for payers to exchange member data during health plan transitions using Bulk FHIR.
Accessing the APIs Explains secure API access, member consent enforcement, and data-scope limits for payer-to-payer data exchange.
onyxOS, the Interoperability Rule and FHIR Implementation Guides Describes how onyxOS ingests FHIR capability statements to generate APIs and enforce member-level access in compliance with CMS Interoperability requirements.
└─ Implementation Guides For developers who are not familiar with HL7 FHIR Implementation Guides (IGs). An IG provides detailed information on data structures for resource profiles.
└─ Capability Statements Server Capability Statements define the data profiles, operations, access methods and search operations that are supported by the server.
└─ Swagger Files The swagger files enable Payer to better understand the server interactions.
└─ Postman Collection Postman collections for testing onyxOS APIs

OnyxOS Provider API Documentation

Topic Description
Background Guidance for providers to access and exchange clinical and documentation-related data using standardized FHIR APIs.
Accessing the APIs Explains secure API access, authorization mechanisms, and scope enforcement for provider access APIs.
onyxOS, the Interoperability Rule and FHIR Implementation Guides Describes how onyxOS ingests FHIR capability statements to generate Provider APIs in alignment with CMS interoperability requirements.
└─ Implementation Guides For implementers who are not familiar with HL7 FHIR Implementation Guides (IGs). An IG provides detailed information on data structures and provider workflows.
└─ Capability Statements Server Capability Statements define the data profiles, operations, access methods and search operations that are supported by the server.
└─ Swagger Files The swagger files enable providers to better understand the server interactions.
└─ Postman Collection Postman collections for testing onyxOS APIs
Tags: getting_started