FamilyModules GET Insurance

GET /familymodules/{PatNum}/Insurance. PatNum is required in the URL. Returns 0–2 rows typically (one per insurance). Discount plans from DiscountPlanSubs GET. Per OpenDental API FamilyModules.

Example Response:

[
  {
    "PatNum": 13,
    "InsSubNum": 7,
    "Subscriber": 10,
    "subscriber": "Eve Wilkins",
    "SubscriberID": "541147842",
    "SubscNote": "",
    "PatPlanNum": 17,
    "Ordinal": 1,
    "ordinal": "Primary",
    "IsPending": "false",
    "Relationship": "LifePartner",
    "PatID": "",
    "CarrierNum": 8,
    "CarrierName": "BCBS",
    "PlanNum": 7,
    "GroupName": "",
    "GroupNum": "",
    "PlanNote": "",
    "FeeSched": 53,
    "feeSchedule": "Standard",
    "PlanType": "",
    "planType": "Category Percentage",
    "CopayFeeSched": 0,
    "EmployerNum": 0,
    "employer": "",
    "IsMedical": "false"
  }
]

All response fields (with descriptions):

• PatNum — Patient number.
• InsSubNum — inssub.InsSubNum. Primary key to insurance subscriber.
• Subscriber — inssub.Subscriber. The PatNum of the subscriber.
• subscriber — First and last name of Subscriber from patient table.
• SubscriberID — inssub.SubscriberID. Number assigned by insurance company (e.g. Medicaid ID).
• SubscNote — inssub.SubscNote. Other information that affects coverage.
• PatPlanNum — patplan.PatPlanNum. Primary key to patient plan.
• Ordinal — patplan.Ordinal. Numerical order: 1, 2, 3 (Primary, Secondary, etc.).
• ordinal — Description of Ordinal: Primary, Secondary, Medical, or Other insurance.
• IsPending — patplan.IsPending. true/false. Incomplete or unverified insurance.
• Relationship — patplan.Relationship to subscriber: Self, Spouse, Child, Employee, HandicapDep, SignifOther, InjuredPlaintiff, LifePartner, or Dependant.
• PatID — patplan.PatID. Optional patient ID overriding Subscriber ID on eclaims.
• CarrierNum — carrier.CarrierNum. Primary key to the carrier.
• CarrierName — carrier.CarrierName. Full name of carrier.
• PlanNum — insplan.PlanNum. Primary key to the insurance plan.
• GroupName — insplan.GroupName. Typically similar to employer.
• GroupNum — insplan.GroupNum. Issued by the carrier.
• PlanNote — insplan.PlanNote. Notes for subscriber and family.
• FeeSched — insplan.FeeSched. FK to feesched.FeeSchedNum.
• feeSchedule — feesched.Description of the fee schedule.
• PlanType — insplan.PlanType. ""=percentage, "p"=ppo percentage, "f"=flat copay, "c"=capitation.
• planType — Description: Category Percentage, PPO Fixed Benefit, PPO Percentage, Medicaid or Flat Co-pay, or Capitation.
• CopayFeeSched — insplan.CopayFeeSched. FK to feesched.FeeSchedNum.
• EmployerNum — insplan.EmployerNum. FK to employer.EmployerNum.
• employer — employer.EmpName. Description of EmployerNum.
• IsMedical — insplan.IsMedical. true if medical (not dental) insurance.