Interface: Insurance

IN1-derived insurance entry (HELPERS-06) with positional IN2/IN3 presence flags (D-05 extension). hasIn2 / hasIn3 are ALWAYS present booleans; callers who need the full IN2/IN3 surface can walk msg.segments("IN2").

Example

import type { Insurance } from "@cosyte/hl7";
const ins: Insurance = {
  planId: { identifier: "PLAN1", text: "Aetna PPO" },
  policyNumber: "POL123",
  groupNumber: "GRP1",
  hasIn2: false,
  hasIn3: false,
};

Properties

companyId?

readonly optional companyId?: CX

IN1-3 insurance company id.

---

companyName?

readonly optional companyName?: string

IN1-4 insurance company name (first repetition, first component).

---

effectiveDate?

readonly optional effectiveDate?: DtmParts

IN1-12 plan effective date as the fidelity TS.

---

expirationDate?

readonly optional expirationDate?: DtmParts

IN1-13 plan expiration date as the fidelity TS.

---

groupNumber?

readonly optional groupNumber?: string

IN1-8 group number.

---

hasIn2

readonly hasIn2: boolean

true iff an IN2 segment follows this IN1 before the next IN1.

---

hasIn3

readonly hasIn3: boolean

true iff an IN3 segment follows this IN1 before the next IN1.

---

insuredName?

readonly optional insuredName?: XPN

IN1-16 insured's name.

---

planId?

readonly optional planId?: CWE

IN1-2 insurance plan id.

---

policyNumber?

readonly optional policyNumber?: string

IN1-36 policy number.