Coverage data model
View field support, webhooks, and list parameters for each integration on the Supported Integrations 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[] | 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[] | 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[] | 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 |
Are we missing anything? Let us know