Skip to main content

​
clinik.eligibilityRequests

Eligibility Requests (FHIR CoverageEligibilityRequest) are used to check insurance eligibility and benefits. ClinikAPI exposes the most commonly used fields — use the FHIR passthrough for advanced eligibility scenarios.

​
create

const { data, meta } = await clinik.eligibilityRequests.create(request): Promise<ApiResponse<CoverageEligibilityRequest>>
FieldTypeRequiredDescription
statusstringYesactive, cancelled, draft
purposestring[]Yesauth-requirements, benefits, discovery, validation
patientIdstringYesPatient ID
createdstringNoWhen created (defaults to now)
insurerIdstringYesInsurer Organization ID
providerIdstringNoProvider (Practitioner/Organization ID)
servicedDatestringNoService date (point in time)
servicedPeriod{ start?, end? }NoService period
insuranceArrayNoInsurance coverages to check
itemArrayNoItems to check eligibility for

​
Insurance Object

FieldTypeRequiredDescription
focalbooleanNoWhether this is the focal coverage
coverageIdstringYesCoverage resource ID

​
Item Object

FieldTypeRequiredDescription
categorystringNoBenefit category
productOrServicestringNoProduct or service code

​
Example

const { data } = await clinik.eligibilityRequests.create({
  status: 'active',
  purpose: ['benefits'],
  patientId: 'pt_abc123',
  insurerId: 'org_ins_bluecross',
  providerId: 'Practitioner/prac_dr456',
  servicedDate: '2024-06-15',
  insurance: [
    { focal: true, coverageId: 'cov_primary789' },
  ],
});
Same pattern as other resources. Update supports status only. Search supports patientId, status, dateFrom, dateTo filters.