Skip to main content

​
clinik.coverages

Coverages (FHIR Coverage) represent a patient’s insurance plan details. ClinikAPI exposes the most commonly used fields — use the FHIR passthrough for advanced coverage scenarios.

​
create

const { data, meta } = await clinik.coverages.create(request): Promise<ApiResponse<Coverage>>
FieldTypeRequiredDescription
statusstringYesactive, cancelled, draft
patientIdstringYesPatient (beneficiary) ID
typestringNomedical, dental, vision, pharmacy
subscriberIdstringNoSubscriber ID on insurance card
subscriberRefstringNoSubscriber reference (Patient/RelatedPerson)
policyHolderRefstringNoPolicy holder reference
relationshipstringNoself, spouse, child, other
period{ start?, end? }NoCoverage period
payorIdsstring[]YesPayor Organization IDs
classArrayNoCoverage classes (group, plan, etc.)
ordernumberNoRelative order of coverage
networkstringNoInsurance plan network
dependentstringNoDependent number
subrogationbooleanNoSubrogation flag

​
Class Object

FieldTypeRequiredDescription
typestringYesClass type (group, plan, subplan, etc.)
valuestringYesClass value
namestringNoHuman-readable name

​
Example

const { data } = await clinik.coverages.create({
  status: 'active',
  patientId: 'pt_abc123',
  type: 'medical',
  subscriberId: 'SUB-98765',
  subscriberRef: 'Patient/pt_abc123',
  relationship: 'self',
  payorIds: ['org_ins_bluecross'],
  period: { start: '2024-01-01', end: '2024-12-31' },
  class: [
    { type: 'group', value: 'GRP-100', name: 'Employer Group Plan' },
    { type: 'plan', value: 'PLN-GOLD', name: 'Gold PPO' },
  ],
  network: 'PPO Network',
});
Same pattern as other resources. Update supports status, period, network. Search supports patientId, status, type, payorId filters.