--- title: "Coverage data model" url: "https://docs.unified.to/healthcare/coverage/model" description: "The Coverage data model object in Unified's Coverage API: 18 fields, including created_at, updated_at and patient_id, with types and enum values." date: "2026-10-24T20:36:42.560Z" updated: "2026-10-24T20:36:42.560Z" --- # Coverage data model Updated: October 24, 2026 View field support, webhooks, and list parameters for each integration on the [Supported Integrations](https://docs.unified.to/healthcare/integrations.md) page. | Field | Type | Required | Description | | ------------------------ | ----------------------------------------------------------------------------------------------------- | -------- | ------------------------------------------------------------------------------------------ | | id | string | No | Unique identifier for the coverage | | created\_at | string (date-time) | No | When the coverage record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | updated\_at | string (date-time) | No | When the coverage record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | patient\_id | string | No | The patient covered by the insurance (beneficiary) | | status | enum | No | Status of the coverage Values: ACTIVE, CANCELLED, DRAFT, ENTERED\_IN\_ERROR, OTHER | | codes | [HealthcareCode](https://docs.unified.to/healthcare/coverage/model.md#HealthcareCode)\[\] | No | Codings for the type of coverage (e.g. Medicare, commercial PPO) | | codes\[\].system | string | No | The code system URI (e.g. http://loinc.org, http://snomed.info/sct) | | codes\[\].code | string | No | The code within the system | | codes\[\].display | string | No | Human-readable display text for the code | | payer\_name | string | No | Name of the insurer or payer | | plan\_name | string | No | Name of the insurance plan | | group\_name | string | No | Name of the employer group or plan group | | group\_identifier | string | No | Group number of the plan (reference to HrisGroup) | | member\_identifier | string | No | Member/subscriber number on the insurance card | | subscriber\_name | string | No | Name of the policy holder | | relationship | enum | No | Relationship of the patient to the policy holder Values: SELF, SPOUSE, CHILD, OTHER | | priority | number | No | Order in which the coverage is applied (1 = primary) | | start\_at | string (date-time) | No | When the coverage starts (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | end\_at | string (date-time) | No | When the coverage ends (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | identifiers | [HealthcareIdentifier](https://docs.unified.to/healthcare/coverage/model.md#HealthcareIdentifier)\[\] | No | Business identifiers for the coverage | | identifiers\[\].value | string | Yes | The identifier value | | identifiers\[\].type | enum | No | The kind of identifier Values: MRN, NPI, SSN, DRIVERS\_LICENSE, PASSPORT, INSURANCE, OTHER | | identifiers\[\].system | string | No | The namespace/system URI that issued the identifier | | metadata | [HealthcareMetadata](https://docs.unified.to/healthcare/coverage/model.md#HealthcareMetadata)\[\] | No | Custom field values | | metadata\[\].id | string | No | Identifier of the custom field | | metadata\[\].value | object | No | The custom field value | | metadata\[\].namespace | string | No | The scope or origin of the custom field | | metadata\[\].format | enum | No | The data type of the value Values: TEXT, NUMBER, DATE, BOOLEAN, ARRAY, OBJECT | | metadata\[\].extra\_data | object | No | Additional data about the custom field | | metadata\[\].slug | string | No | The custom field key | ## TypeScript ```typescript export type HealthcareCoverage = { id?: string; // Unique identifier for the coverage created_at?: string-time; // When the coverage record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) updated_at?: string-time; // When the coverage record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) patient_id?: string; // The patient covered by the insurance (beneficiary) status?: 'ACTIVE' | 'CANCELLED' | 'DRAFT' | 'ENTERED_IN_ERROR' | 'OTHER'; // Status of the coverage codes?: []; // Codings for the type of coverage (e.g. Medicare, commercial PPO) payer_name?: string; // Name of the insurer or payer plan_name?: string; // Name of the insurance plan group_name?: string; // Name of the employer group or plan group group_identifier?: string; // Group number of the plan (reference to HrisGroup) member_identifier?: string; // Member/subscriber number on the insurance card subscriber_name?: string; // Name of the policy holder relationship?: 'SELF' | 'SPOUSE' | 'CHILD' | 'OTHER'; // Relationship of the patient to the policy holder priority?: number; // Order in which the coverage is applied (1 = primary) start_at?: string-time; // When the coverage starts (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) end_at?: string-time; // When the coverage ends (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) identifiers?: []; // Business identifiers for the coverage metadata?: []; // Custom field values raw?: any; // Raw data from integration } ``` ## Zod ```typescript import { z } from 'zod'; export const ZodHealthcareCoverage = z.object({ id: z.string().optional().describe("Unique identifier for the coverage"), created_at: z.string-time().optional().describe("When the coverage record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"), updated_at: z.string-time().optional().describe("When the coverage record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"), patient_id: z.string().optional().describe("The patient covered by the insurance (beneficiary)"), status: z.enum("ACTIVE", "CANCELLED", "DRAFT", "ENTERED_IN_ERROR", "OTHER").optional().describe("Status of the coverage"), codes: z.array().optional().describe("Codings for the type of coverage (e.g. Medicare, commercial PPO)"), payer_name: z.string().optional().describe("Name of the insurer or payer"), plan_name: z.string().optional().describe("Name of the insurance plan"), group_name: z.string().optional().describe("Name of the employer group or plan group"), group_identifier: z.string().optional().describe("Group number of the plan (reference to HrisGroup)"), member_identifier: z.string().optional().describe("Member/subscriber number on the insurance card"), subscriber_name: z.string().optional().describe("Name of the policy holder"), relationship: z.enum("SELF", "SPOUSE", "CHILD", "OTHER").optional().describe("Relationship of the patient to the policy holder"), priority: z.number().optional().describe("Order in which the coverage is applied (1 = primary)"), start_at: z.string-time().optional().describe("When the coverage starts (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"), end_at: z.string-time().optional().describe("When the coverage ends (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"), identifiers: z.array().optional().describe("Business identifiers for the coverage"), metadata: z.array().optional().describe("Custom field values"), }); ``` ## Python ```python import dataclasses @dataclasses.dataclass class HealthcareCoverageStatus(str, Enum): ACTIVE = 'ACTIVE' CANCELLED = 'CANCELLED' DRAFT = 'DRAFT' ENTERED_IN_ERROR = 'ENTERED_IN_ERROR' OTHER = 'OTHER' @dataclasses.dataclass class HealthcareCoverageRelationship(str, Enum): SELF = 'SELF' SPOUSE = 'SPOUSE' CHILD = 'CHILD' OTHER = 'OTHER' @dataclasses.dataclass class HealthcareCoverage: """Unique identifier for the coverage""" id: Optional[str] """When the coverage record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)""" created_at: Optional[str] """When the coverage record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)""" updated_at: Optional[str] """The patient covered by the insurance (beneficiary)""" patient_id: Optional[str] """Status of the coverage""" status: Optional[HealthcareCoverageStatus] """Codings for the type of coverage (e.g. Medicare, commercial PPO)""" codes: Optional[PropertyHealthcareCoverageCodes] """Name of the insurer or payer""" payer_name: Optional[str] """Name of the insurance plan""" plan_name: Optional[str] """Name of the employer group or plan group""" group_name: Optional[str] """Group number of the plan (reference to HrisGroup)""" group_identifier: Optional[str] """Member/subscriber number on the insurance card""" member_identifier: Optional[str] """Name of the policy holder""" subscriber_name: Optional[str] """Relationship of the patient to the policy holder""" relationship: Optional[HealthcareCoverageRelationship] """Order in which the coverage is applied (1 = primary)""" priority: Optional[int] """When the coverage starts (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)""" start_at: Optional[str] """When the coverage ends (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)""" end_at: Optional[str] """Business identifiers for the coverage""" identifiers: Optional[PropertyHealthcareCoverageIdentifiers] """Custom field values""" metadata: Optional[PropertyHealthcareCoverageMetadata] ```