Skip to main content

​
clinik.eligibilityResponses

Eligibility Responses (FHIR CoverageEligibilityResponse) contain the results of an eligibility check. ClinikAPI exposes the most commonly used fields — use the FHIR passthrough for advanced eligibility scenarios.

​
create

const { data, meta } = await clinik.eligibilityResponses.create(request): Promise<ApiResponse<CoverageEligibilityResponse>>
FieldTypeRequiredDescription
statusstringYesactive, cancelled, draft
purposestring[]YesPurpose codes
patientIdstringYesPatient ID
createdstringNoWhen created (defaults to now)
requestIdstringNoCoverageEligibilityRequest ID
outcomestringYesqueued, complete, error, partial
insurerIdstringYesInsurer Organization ID
dispositionstringNoDisposition message
insuranceArrayNoInsurance details
preAuthRefstringNoPre-authorization reference
errorArrayNoProcessing errors

​
Insurance Object

FieldTypeRequiredDescription
coverageIdstringYesCoverage resource ID
inforcebooleanNoWhether coverage is in force
benefitPeriod{ start?, end? }NoBenefit period

​
Error Object

FieldTypeRequiredDescription
codestringYesError code

​
Example

const { data } = await clinik.eligibilityResponses.create({
  status: 'active',
  purpose: ['benefits'],
  patientId: 'pt_abc123',
  insurerId: 'org_ins_bluecross',
  requestId: 'eligreq_xyz456',
  outcome: 'complete',
  disposition: 'Coverage is active with standard benefits',
  insurance: [
    {
      coverageId: 'cov_primary789',
      inforce: true,
      benefitPeriod: { start: '2024-01-01', end: '2024-12-31' },
    },
  ],
});
Same pattern as other resources. Update supports status, disposition. Search supports patientId, status, outcome, requestId filters.