Skip to main content

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.

Financial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment. Reference Table: The coverage_references table contains normalized references from the coverage to other entities. It supports the following reference properties:
  • beneficiary (required): links to the patient who is the beneficiary of the coverage
  • payor: links to the organization or patient responsible for payment
  • policyHolder: links to the owner of the insurance policy
  • subscriber: links to the subscriber to the insurance policy
For detailed information about reference table structure and indexing, see the Reference Tables documentation. Coverage Table: Primary Keys:
  • coverage_id
Foreign Keys:
  • patient_id
ColumnData TypeDescription
coverage_idvarcharUnique identifier for the coverage
patient_idvarcharUnique identifier for the patient (beneficiary)
statusvarcharStatus of the coverage. Possible values:
active: The coverage is currently in effect.
cancelled: The coverage has been cancelled.
draft: The coverage is in draft state.
entered-in-error: The coverage was entered in error.
period_startdateStart date of the coverage period
period_enddateEnd date of the coverage period
type_codevarcharCode for coverage type
type_displayvarcharHuman-readable description of coverage type
type_systemvarcharCoding system for coverage type
subscriber_member_idvarcharSubscriber member identifier
dependentvarcharDependent number
relationship_codevarcharCode for relationship
relationship_displayvarcharHuman-readable description of relationship
relationship_systemvarcharCoding system for relationship
class_group_codevarcharGroup class code
class_group_displayvarcharHuman-readable description of group class
class_group_systemvarcharCoding system for group class
class_plan_codevarcharPlan class code
class_plan_displayvarcharHuman-readable description of plan class
class_plan_systemvarcharCoding system for plan class
meta_sourcevarcharSource document filename from FHIR meta.source
data_sourcevarcharDeprecated. Use meta_source instead.
data_source_extvarcharIntegration source of the data, derived from FHIR extension