> ## Documentation Index
> Fetch the complete documentation index at: https://docs.metriport.com/llms.txt
> Use this file to discover all available pages before exploring further.

# coverage

Financial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment. See the [HL7 FHIR R4 spec](https://hl7.org/fhir/R4/coverage.html) for full details.

**Previous version:** [coverage](/medical-api/handling-data/schema-v000/coverage)

**Tables in this resource:**

* **coverage** – Main coverage record (this page)
* [coverage\_type\_coding](/medical-api/handling-data/schema-v100/coverage/type_coding)
* [coverage\_relationship\_coding](/medical-api/handling-data/schema-v100/coverage/relationship_coding)
* [coverage\_class](/medical-api/handling-data/schema-v100/coverage/class) – Backbone for class
* [coverage\_class\_type\_coding](/medical-api/handling-data/schema-v100/coverage/class_type_coding)
* [coverage\_extension](/medical-api/handling-data/schema-v100/coverage/extension)
* [coverage\_extension\_vcc\_coding](/medical-api/handling-data/schema-v100/coverage/extension_vcc_coding)
* **coverage\_references** – Normalized references; see [Reference Tables](/medical-api/handling-data/schema-v100/reference_tables)

**Primary Keys:**

* coverage\_id

**Foreign Keys:**

* patient\_id - links to the [patient](/medical-api/handling-data/schema-v100/patient/base) table (beneficiary)

<div style={{ textAlign: "right" }}>
  <sub>† Metriport Platform added</sub>
</div>

| Column | Data Type | Description |
| - | - | - |
| coverage\_id | varchar | Unique identifier for the coverage |
| patient\_id | varchar | Unique identifier for the patient (beneficiary) |
| status | varchar | Status of the coverage (e.g. active, cancelled, draft, entered-in-error) |
| period\_start | datetime | Start of the coverage period |
| period\_end | datetime | End of the coverage period |
| type\_text | varchar | Free-text coverage type |
| type\_hl7\_code† | varchar | Coverage type: HL7 ActCode (v3-ActCode) |
| type\_hl7\_display† | varchar | Coverage type: HL7 ActCode display |
| relationship\_text | varchar | Free-text subscriber relationship |
| relationship\_hl7\_code† | varchar | Subscriber relationship: HL7 code (subscriber-relationship) |
| relationship\_hl7\_display† | varchar | Subscriber relationship: HL7 display |
| subscriberid | varchar | Subscriber identifier |
| dependent | varchar | Dependent number |
| meta\_source | varchar | Source document filename from FHIR meta.source |
| data\_source\_ext† | varchar | Integration source of the data, derived from FHIR extension |

**Related Tables:**

**Parent:**

* [patient](/medical-api/handling-data/schema-v100/patient/base)

**Child:**

* [coverage\_class](/medical-api/handling-data/schema-v100/coverage/class)
* [coverage\_extension](/medical-api/handling-data/schema-v100/coverage/extension)
* [coverage\_relationship\_coding](/medical-api/handling-data/schema-v100/coverage/relationship_coding)
* [coverage\_type\_coding](/medical-api/handling-data/schema-v100/coverage/type_coding)

## Version diff

**Renamed**

* `subscriber_member_id` → `subscriberid`
* `data_source` → `meta_source`

**Moved to separate tables**

* `source_type_code` → [`coverage_type_coding.code`](/medical-api/handling-data/schema-v100/coverage/type_coding) w/ `code_rank = 1`
* `source_type_display` → [`coverage_type_coding.display`](/medical-api/handling-data/schema-v100/coverage/type_coding) w/ `code_rank = 1`
* `source_type_system` → [`coverage_type_coding.system`](/medical-api/handling-data/schema-v100/coverage/type_coding) w/ `code_rank = 1`
* `source_relationship_code` → [`coverage_relationship_coding.code`](/medical-api/handling-data/schema-v100/coverage/relationship_coding) w/ `code_rank = 1`
* `source_relationship_display` → [`coverage_relationship_coding.display`](/medical-api/handling-data/schema-v100/coverage/relationship_coding) w/ `code_rank = 1`
* `source_relationship_system` → [`coverage_relationship_coding.system`](/medical-api/handling-data/schema-v100/coverage/relationship_coding) w/ `code_rank = 1`
* `class_group_code`, `class_group_display`, `class_group_system` → [`coverage_class`](/medical-api/handling-data/schema-v100/coverage/class) w/ `type_code = group`
* `class_plan_code`, `class_plan_display`, `class_plan_system` → [`coverage_class`](/medical-api/handling-data/schema-v100/coverage/class) w/ `type_code = plan`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.