Payer Plans
Datasets
Part of the Drug Formulary feed, built to Da Vinci PDex US Drug Formulary STU 2.1.0. The feed's data conventions apply.
A payer plan is one Payer Insurance Plan (InsurancePlan). The profile nests several repeating structures, and every one that may repeat is its own dataset here: the root file carries what occurs once per plan, and each child file carries one repeating element, keyed back to its parent. This mirrors the profile's slices one to one.
A repeating element is carried one of two ways. A structure with fields of its own is a child dataset, one row per occurrence. A repeating reference, code or short text with no fields of its own is a ;-separated list column on its parent row. Free-text lists such as aliases must not contain ; inside a value; a value that needs one goes in a single-value column or its own row.
| Dataset | Element | Cardinality | Parent |
|---|---|---|---|
payer_plans | InsurancePlan | one per plan | |
plan_identifiers | identifier | 1..* | payer_plans |
plan_contacts | contact | 0..*, must support | payer_plans |
coverage_areas | coverageArea, an Insurance Plan Location | 0..*, must support | payer_plans, drug_plans, formularies |
plan_drug_coverages | coverage:drug-coverage | 1..* | payer_plans |
drug_coverage_benefits | coverage:drug-coverage.benefit:drug-plan | 1..* | plan_drug_coverages |
drug_plans | plan:drug-plan | 1..* | payer_plans |
drug_plan_specific_costs | plan:drug-plan.specificCost | 1..* | drug_plans |
drug_plan_tier_benefits | plan:drug-plan.specificCost.benefit | 1..* | drug_plan_specific_costs |
drug_plan_tier_costs | plan:drug-plan.specificCost.benefit.cost | 1..* | drug_plan_tier_benefits |
drug_plan_general_costs | plan:drug-plan.generalCost | 0..* | drug_plans |
Repeating references and codes that carry no fields of their own stay as ;-separated lists on their parent row: network_ids, coverage_area_ids, formulary_ids, plan_aliases.
payer_plans
One row per plan: the elements of the InsurancePlan that occur once.
| Column | Required | Format / values | Example |
|---|---|---|---|
plan_id | Yes | your stable key for the plan; every child dataset references it, and it is the same value as in Provider Directory plans | PLAN-DSNP |
plan_name | Recommended | text | Example Health D-SNP |
plan_aliases | If renamed | earlier names, ;-separated, up to three | |
status | Yes | active, draft, retired, unknown publication-status | active |
plan_type | Yes | mediadv Medicare Advantage, mediadvhmo MA HMO InsuranceProductTypeVS | mediadv |
period_start | Recommended | date the plan year begins | 2027-01-01 |
period_end | Recommended | date the plan year ends | 2027-12-31 |
coverage_area_ids | Recommended | keys from coverage_areas, ;-separated | AREA-NY |
owned_by_org_identifier | Recommended | Plan issuer | 99999 |
administered_by_org_identifier | Yes | Product administrator | 99999 |
network_ids | If available | networks of the product, keys from Provider Directory networks, ;-separated; each must be a network that feed has published, or the plan waits for it | NET-001 |
last_updated | Yes | datetime with a timezone offset, YYYY-MM-DDThh:mm:ss±hh:mm, when the plan last changed in your system; a date alone holds the row back | 2026-10-01T09:00:00-05:00 |
is_deleted | If retracting | true sets the published plan's status to retired; every child row that references it goes with it | true |
plan_idbecomes the plan's first identifier, under the identifier namespace fixed for your engagement. Further identifiers, such as the CMS contract-plan-segment, are rows inplan_identifiers.- A plan is complete only with its children. The profile requires at least one drug coverage and at least one drug plan with a cost table, so a
payer_plansrow with noplan_drug_coveragesrow or nodrug_plansrow is reported and not published. - Plan-Net defines
ownedByas "the entity that is providing the health insurance product and underwriting the risk. This is typically an insurance carriers, other third-party payers, or health plan sponsors commonly referred to as 'payers'." - Plan-Net defines
administeredByas "an organization which administer other services such as underwriting, customer service and/or claims processing on behalf of the health insurance product owner." is_deletedon the plan retracts the whole tree. Child rows have their ownis_deletedfor dropping one contact, one cost cell or one identifier from the plan; a child row absent from the snapshot is dropped the same way when the plan is next built.
How the datasets become the resource
| Element | Cardinality | Filled from |
|---|---|---|
meta.lastUpdated | 1..1 | payer_plans.last_updated |
identifier | 1..* | plan_id, then one per plan_identifiers row |
status, type, name, alias, period | payer_plans columns | |
ownedBy, administeredBy | owned_by_org_identifier, administered_by_org_identifier | |
coverageArea | 0..*, must support | one Insurance Plan Location per coverage_area_ids value, from coverage_areas |
contact | 0..*, must support | one per plan_contacts row |
network | network_ids | |
coverage:drug-coverage | 1..* | one per plan_drug_coverages row; type fixed to drug policy; the formulary-reference extension holds each formulary_ids value |
coverage:drug-coverage.benefit:drug-plan | 1..* | one per drug_coverage_benefits row; type fixed to drug |
plan:drug-plan | 1..* | one per drug_plans row; type fixed to drug; identifier from drug_plan_id |
plan:drug-plan.specificCost | 1..*, must support | one per drug_plan_specific_costs row; category is the pharmacy benefit type |
plan:drug-plan.specificCost.benefit | 1..*, must support | one per drug_plan_tier_benefits row; type is the drug tier |
plan:drug-plan.specificCost.benefit.cost | 1..* | one per drug_plan_tier_costs row, into the copay or coinsurance slice by cost_type |
plan:drug-plan.generalCost | 0..* | one per drug_plan_general_costs row |
Every column maps to an element of the IG's own profiles; the feed defines no extensions. The one element the profile leaves optional and this feed does not collect is endpoint.
These resources are served by Patient Access.