API ReferencePre EncounterCoveragesV1

Check Eligibility

Beta
Initiates an eligibility check. Returns the metadata of the check if successfully initiated.

Path parameters

idUUIDRequired
The unique identifier for a Coverage in the database

Headers

AuthorizationstringRequired

OAuth authentication of the form <token>.

Request

This endpoint expects an object.
service_codeenumRequired

Code identifying the type of service or benefit within a specific insurance policy (X12 008010 Element 1365)

date_of_servicedateRequired
npistringRequired

Response

This endpoint returns an object.
check_idstring
service_codeenum

Code identifying the type of service or benefit within a specific insurance policy (X12 008010 Element 1365)

statusenum
enum to represent the status of an eligibility checks
Allowed values:
initiated_bystring
The unique identifier for a User in the database
initiated_atdatetime