Real Time Data API

The Real Time Data API is an alternative to the typical file-based process for loading data to the Healthx database.  It allows for real time updates to individual records in response to events in a source system.

All requests to a real time API are executed asynchronously, based on Microsoft's guidelines for Long Running Operations.  A link to the Operation endpoint is included in the response header of successful requests that can be used to look up the status of a request.

The data APIs generally match the structure of the data file specs they are based on and support all of the same fields (though the field names should be lowercased in the API).

Child records (e.g. coverage items associated to an eligibility record) can be nested under their parent record (e.g. you can call the Eligibility API to update eligibility fields and associated coverages in one call).

Each entity has one or more key fields that are used to identify it, these are mandatory and are provided through query parameters.

The base url for all endpoints is https://dapi.healthx.com.

A C# example client is available here.

Status

The Status API allows you to check the health of the Real Time Data API system.


Operation

The Operation API allows you to check the status of a real time transaction after it has been submitted.

Operation

Eligibility

The Eligibility Data API allows you to create, update, and delete any of your eligibility data at Healthx.  Fields supported and referenced in the below documentation match the fields specified in the data specification documentation here.


The Authorization API allows you to create, update, and delete any of your authorization data at Healthx.  Fields supported and referenced in the below documentation match the fields specified in the data specification documentation here.