External Service APIs
Complete reference for all third-party services and government systems that eKlotho Nexus integrates with. Covers required connections, optional enrichment services, setup procedures, authentication methods, and endpoint specifications for each external provider.
On This Page
eKlotho Nexus connects to external services across four categories
| Service | Provider / Standard | Protocol | Requirement | Modules Used By |
|---|---|---|---|---|
| EDI Clearinghouse | Availity, Change Healthcare, Waystar | X12 EDI | Required | Claims, Enrollment, Auth |
| CMS HETS | Centers for Medicare & Medicaid Services | EDI 270/271 | Required | Eligibility, Billing |
| NPPES NPI Registry | CMS / NLM | REST | Required | Providers, Claims, Enrollment |
| State Medicaid Portal | State agencies (varies) | EDI / REST | Required | Enrollment, Eligibility |
| Surescripts / NCPDP | Surescripts, NCPDP SCRIPT | SOAP / HL7 | Recommended | Medications, Clinical |
| HL7 FHIR EHR | Epic, Cerner, Athena, Allscripts | FHIR R4 | Recommended | Clinical, Patients, Care Coordination |
| CMS PECOS | Centers for Medicare & Medicaid Services | REST | Recommended | Providers, Credentialing |
| State HIE | State Health Information Exchange | FHIR / HL7 v2 | Recommended | Clinical, Population Health |
| CLIA / Lab Results | HL7 v2.x ORU messages | HL7 v2 | Optional | Clinical, Vitals |
| OIG LEIE / SAM | HHS Office of Inspector General | REST / CSV | Optional | Credentialing, Compliance |
| ICD-10 / CPT Lookup | CMS, AMA, NLM | REST | Optional | Claims, Clinical |
| RxNorm / NDC | NLM RxNorm API | REST | Optional | Medications, Pharmacy |
| Geocoding / SDOH | Census Bureau / Google Maps | REST | Optional | Population Health, SDOH |
| Identity Verification | Experian, Equifax Health | REST | Optional | Enrollment, Patient Management |
| Telehealth Platform | Zoom Health, Doxy.me | REST / WebRTC | Optional | Appointments, Telehealth |
| SMS / Communication | Twilio, AWS SNS | REST | Optional | Communication, Alerts |
These services must be configured before the system goes live. Claims processing, eligibility verification, and provider lookup depend on them.
An EDI clearinghouse is the central transaction hub for all HIPAA X12 electronic data interchange โ claims submission (837), remittance advice (835), eligibility (270/271), referrals and authorizations (278), and enrollment (834). eKlotho Nexus supports direct connection to Availity, Change Healthcare, and Waystar, or any clearinghouse that supports SFTP/AS2 transport with X12 005010 transactions.
| EDI Set | Purpose | Direction |
|---|---|---|
837P | Professional Claims | Outbound |
837I | Institutional Claims | Outbound |
837D | Dental Claims | Outbound |
835 | Remittance Advice / ERA | Inbound |
270/271 | Eligibility Inquiry / Response | Both |
276/277 | Claim Status Request / Response | Both |
278 | Authorization Request / Response | Both |
834 | Benefit Enrollment & Maintenance | Both |
820 | Premium Payment | Outbound |
999/TA1 | Functional Acknowledgment | Inbound |
| transport_protocol | SFTP, AS2, HTTPS |
| isa_sender_id | Your ISA06 Interchange Sender ID |
| isa_receiver_id | Clearinghouse ISA08 Receiver ID |
| gs_sender_id | Functional Group Sender ID |
| version | 005010X222A1, 005010X221A1 |
| sftp_host | Provided by clearinghouse |
| sftp_port | 22 (SFTP) / 443 (AS2/HTTPS) |
| inbound_dir | /inbound (ERA, 271, 277, 278) |
| outbound_dir | /outbound (837, 270, 276, 834) |
| ack_dir | /acks (999, TA1) |
| poll_interval | 15 minutes (configurable) |
The CMS Healthcare Eligibility Transaction System (HETS) provides real-time Medicare Part A, Part B, Part C, and Part D eligibility verification using EDI 270/271 transactions. Required for any organization serving Medicare beneficiaries.
| endpoint | HETS 270/271 via EDI submitter |
| access | Requires CMS Trading Partner Agreement (TPA) |
| submitter_id | CMS-assigned 10-digit submitter ID |
| transaction | EDI 270 request โ 271 response |
| real_time | Yes โ sub-2 second response |
| batch | Yes โ overnight batch files via SFTP |
| hets_version | HETS 270/271 005010X279A1 |
- Medicare Part A/B/C/D coverage dates
- Medicare Advantage plan details
- Deductible amounts (met/remaining)
- Copay and coinsurance amounts
- Primary/secondary coordination of benefits
- Medicare Secondary Payer (MSP) information
- Hospice election dates
- Home health episode dates
- Register as CMS Trading PartnerSubmit Trading Partner Agreement (TPA) at
https://www.cms.gov/Research-Statistics-Data-and-Systems/CMS-Information-Technology/AccesstoDataApplication - Obtain Submitter IDCMS will issue a 10-digit submitter ID and HETS 270 enrollment confirmation.
- Configure ISA/GS envelopesUpdate ISA06 (your submitter ID) and ISA08 (CMS receiver:
CMS) in Admin โ EDI Config. - Test on CMS HETS Test GatewayCMS provides a test environment. Submit sample 270s and verify 271 responses before production cutover.
- Enable Real-Time VerificationActivate in Admin โ EDI Config โ Real-Time Eligibility. eKlotho Nexus will auto-query on patient search.
The National Plan and Provider Enumeration System (NPPES) provides free public access to the NPI Registry โ the definitive source for National Provider Identifier lookup, provider demographics, specialty, address, and taxonomy. Used for provider credentialing, claim validation, and network management.
// GET /api/?number=1234567890&version=2.1 { "result_count": 1, "results": [{ "number": "1234567890", "enumeration_type": "NPI-1", "basic": { "first_name": "Jane", "last_name": "Smith", "credential": "MD", "sole_proprietor": "NO", "enumeration_date": "2010-03-15", "status": "A" }, "taxonomies": [{ "code": "207R00000X", "desc": "Internal Medicine", "primary": true, "state": "CA", "license": "A12345" }], "addresses": [{ "address_1": "123 Medical Dr", "city": "Los Angeles", "state": "CA", "postal_code": "90001", "telephone_number": "310-555-0100" }] }] }
Each state's Medicaid agency operates its own MMIS (Medicaid Management Information System) with unique connection requirements. eKlotho Nexus supports X12 EDI, HL7 FHIR, and state-specific proprietary APIs. The following table lists key states and their connection methods.
| State | System | Protocol | Eligibility | Claims | Notes |
|---|---|---|---|---|---|
| California | Medi-Cal DHCS | EDI 5010 / FHIR | 270/271 | 837P/I | Requires Direct Data Entry (DDE) setup |
| Texas | TMHP | EDI 5010 | 270/271 | 837P/I | Separate submitter ID per NPI |
| New York | eMedNY | EDI 5010 / SOAP | 270/271 + ePACES | 837P/I | ePACES real-time for eligibility |
| Florida | FL Medicaid FMMIS | EDI 5010 | 270/271 | 837P/I/D | Requires FL Medicaid Provider ID |
| Illinois | HFS MMIS | EDI 5010 | 270/271 | 837P/I | Web portal submission available |
| Pennsylvania | PROMISe | EDI 5010 | 270/271 | 837P/I/D | PROMISe NPI required |
| Arizona | AHCCCS | EDI 5010 / REST | FHIR Eligibility | 837P/I | FHIR R4 eligibility available |
Strongly advised for organizations with full medication management, EHR interoperability, or population health programs.
Surescripts / NCPDP ePrescribing
Real-time electronic prescribing, medication history retrieval, formulary checking, and pharmacy routing. Required for DEA-compliant EPCS (Electronic Prescribing for Controlled Substances).
| Feature | Standard | Notes |
|---|---|---|
| NewRx / RenewRx | NCPDP SCRIPT 10.6 / 2017071 | New and renewal prescriptions |
| Medication History | NCPDP SCRIPT RxHistoryRequest | 180-day fill history |
| Formulary Check | NCPDP Formulary & Benefit | Real-time formulary status |
| EPCS | DEA 21 CFR Part 1311 | Requires DEA EPCS certification |
| CancelRx | NCPDP SCRIPT | Cancel in-progress Rx |
| RxFill / Status | NCPDP SCRIPT | Pharmacy fill notification |
HL7 FHIR EHR Connections
Bi-directional clinical data exchange with EHR systems using HL7 FHIR R4. Enables patient record sync, care plan import, diagnostic results, and medication reconciliation across care team members.
| EHR | FHIR Endpoint Pattern | Auth |
|---|---|---|
| Epic | https://{instance}.epic.com/api/FHIR/R4 | SMART on FHIR |
| Cerner | https://fhir-ehr.cerner.com/r4/{tenant} | SMART on FHIR |
| Athena | https://api.platform.athenahealth.com/fhir/r4 | OAuth 2.0 |
| Allscripts | https://{instance}.allscripts.com/FHIR | OAuth 2.0 |
| eClinicalWorks | https://{instance}.eclinicalworks.com/fhir/ | SMART on FHIR |
CMS PECOS Provider Enrollment
PECOS is the CMS provider enrollment and re-validation system. Used for verifying Medicare enrollment status, checking reassignment of benefits, and confirming ordering/referring eligibility for claims adjudication.
State Health Information Exchange (HIE)
State HIEs provide cross-organizational clinical data sharing including ADT notifications, care summaries (C-CDA), lab results, and immunization records. Critical for care coordination and transitions of care programs.
| Network | States | Protocol |
|---|---|---|
| CommonWell Health Alliance | Nationwide | FHIR R4 |
| Carequality | Nationwide | FHIR / IHE XDS |
| eHealth Exchange | Nationwide (Federal) | IHE XDS, C-CDA |
| CRISP (MD/DC/WV) | Mid-Atlantic | HL7 v2, C-CDA |
| LANES (Los Angeles) | California | HL7 v2, FHIR |
| SHIN-NY | New York | HL7 v2, FHIR |
These integrations enhance specific workflows but are not required for core operations.
OIG LEIE / SAM.gov
OptionalExclude list screening for providers and vendors. Required for Medicare/Medicaid compliance. OIG updates monthly; SAM updates daily.
https://exclusions.oig.hhs.gov/apiSAM:
https://api.sam.gov/entity-informationICD-10 / CPT Code Lookup
OptionalReal-time diagnosis (ICD-10-CM), procedure (CPT/HCPCS), and DRG code lookup for claims entry, clinical documentation, and prior authorization workflows.
https://clinicaltables.nlm.nih.gov/api/icd10cm/v3/searchRxNorm / NDC Drug Database
OptionalDrug name normalization, NDC-to-RxNorm mapping, drug interaction checking, and formulary cross-referencing. Essential for medication reconciliation and pharmacy benefit management.
https://rxnav.nlm.nih.gov/RESTCLIA Lab Results (HL7 v2)
OptionalInbound lab results via HL7 v2 ORU^R01 messages from CLIA-certified labs. Supports LOINC-coded observations, critical value flags, and auto-population of patient records.
Geocoding / SDOH Enrichment
OptionalAddress geocoding for SDOH (Social Determinants of Health) scoring, Area Deprivation Index (ADI) calculation, food desert mapping, and transportation barrier identification.
https://geocoding.geo.census.gov/geocoderIdentity Verification
OptionalPatient identity verification, duplicate MRN detection, MPI (Master Patient Index) reconciliation, and insurance eligibility pre-verification at enrollment.
Telehealth Platform
OptionalEmbedded telehealth session launching from appointment scheduling. Generates HIPAA-compliant video visit links, sends patient join links via SMS/email, and logs encounter metadata.
SMS / Push Notifications
OptionalOutbound patient and provider SMS notifications for appointment reminders, authorization status updates, care gap alerts, and emergency broadcasts.
HEDIS / Stars Reporting
OptionalNCQA-certified HEDIS measure calculation engine integration. Supports HEDIS MY measures, CMS Part C/D Star ratings, and ACO REACH quality metrics reporting.
General procedure for configuring any external service integration in eKlotho Nexus
- Navigate to Admin โ Integrations From the left sidebar, go to Administration โ System Admin โ Integrations. You'll see all available integration categories with current connection status.
- Select the integration type Choose the appropriate category: EDI / Clearinghouse, EHR / FHIR, Government APIs, Pharmacy, Labs, or Communication. Each category has a guided setup wizard.
- Enter credentials and endpoints Provide the service-specific connection parameters: API keys, trading partner IDs, SFTP credentials, or OAuth client credentials. All credentials are encrypted at rest using AES-256.
- Configure connection parameters Set polling intervals, timeout values, retry policy, and notification recipients for connection failures. Default values are pre-populated based on the service type.
- Run connectivity test Use the built-in Test Connection button to verify network reachability, authentication, and a sample transaction. A green status indicates readiness.
- Enable for specific workflows Map the integration to specific modules (e.g., eligibility verification on patient search, NPI lookup in provider add, lab results to patient chart). Unmapped integrations will not auto-trigger.
- Monitor in Admin โ Integrations โ Activity Log All integration calls are logged with request/response metadata (no PHI in logs), status codes, and processing times. Set up alerting for error rate thresholds.
How eKlotho Nexus authenticates to each type of external service
Used for EHR FHIR connections (Epic, Cerner, Athena). eKlotho Nexus acts as a SMART on FHIR backend application using client_credentials flow for system-to-system access.
// Token request POST /oauth2/token Content-Type: application/x-www-form-urlencoded grant_type=client_credentials &client_id={client_id} &client_secret={client_secret} &scope=system/*.read system/*.write // Use token in FHIR requests GET /fhir/r4/Patient?identifier={mbi} Authorization: Bearer {access_token}
Used for government APIs (NPI, PECOS, OIG, RxNorm) and third-party services (Twilio, Geocoding). API keys are stored encrypted in the eKlotho Nexus credential vault.
// API key in header GET /api/v1/providers?npi={npi} X-API-Key: {api_key} X-Organization-ID: {org_id} // HMAC signature (e.g., Surescripts) Authorization: HMAC-SHA256 Credential={key_id}, SignedHeaders=host;date;content-type, Signature={base64_hmac}
Used for EDI clearinghouse file exchange. eKlotho Nexus maintains an SFTP/AS2 agent that polls for inbound files and deposits outbound files on a configurable schedule.
# SFTP connection parameters host=sftp.clearinghouse.com port=22 username={submitter_id} private_key=/path/to/rsa_key.pem known_hosts={clearinghouse_fingerprint} # AS2 parameters as2_from={your_as2_id} as2_to={partner_as2_id} as2_url=https://as2.partner.com/as2 signing_cert=your_cert.p12
Used for real-time HL7 v2 message exchange with labs, hospital ADT systems, and legacy clinical systems. eKlotho Nexus includes an MLLP listener configurable per integration.
// HL7 v2 MLLP connection protocol: MLLP over TCP/IP port: 2575 (configurable) framing: 0x0B {message} 0x1C 0x0D ack_mode: Original (AA/AE/AR) encoding: UTF-8 TLS: TLS 1.2+ recommended // Supported message types inbound: ORU^R01, ADT^A01-A40, SIU^S12 outbound: ORM^O01, QRY^A19
Key HIPAA X12 5010 transaction details relevant to eKlotho Nexus operations
| Transaction Set | Name | Version | Direction | SLA | Key Segments |
|---|---|---|---|---|---|
837P |
Professional Claim | 005010X222A1 | Outbound | Same-day submission | CLM, SV1, NM1, HI (ICD-10) |
837I |
Institutional Claim | 005010X223A2 | Outbound | Same-day submission | CLM, UB04 fields, DRG, revenue codes |
835 |
Electronic Remittance Advice | 005010X221A1 | Inbound | 3-30 days post-claim | CLP, SVC, PLB, CAS (adjustment codes) |
270 |
Eligibility / Benefit Inquiry | 005010X279A1 | Outbound | Real-time or same-day | INS, DTP, EQ (service type) |
271 |
Eligibility / Benefit Response | 005010X279A1 | Inbound | Real-time or same-day | EB (benefit info), MSG, AAA (rejection) |
276 |
Claim Status Request | 005010X212 | Outbound | Real-time batch | CLM, NM1 (payer/provider) |
277 |
Claim Status Response | 005010X212 | Inbound | Real-time batch | STC (status info), NM1 |
278 |
Health Care Services Review | 005010X217 | Both | Real-time or 72h | UM (request type), HI (diagnosis/procedure) |
834 |
Benefit Enrollment & Maintenance | 005010X220A1 | Both | Daily batch | INS, DTP (coverage dates), HD (plan details) |
820 |
Premium Payment | 005010X218 | Outbound | Monthly | ENT, RMR (premium detail) |
999 |
Implementation Acknowledgment | 005010X231A1 | Inbound | Within 1 hour | AK2/AK5 (accept/reject), IK5 (error codes) |
TA1 |
Interchange Acknowledgment | โ | Inbound | Immediate | ISA, TA1 acknowledgment segment |