ExtendedEnrollment

HealthcareMedicareMedicaidFHIRBulk DataOpen DataGovernmentFederalClaimsInsuranceACAMarketplaceQualityHealth InsuranceFederal GovernmentDrug SpendingProvider DataQuality MeasuresClaims DataGovernment Data

Properties

Name Type Description
maxAPTC number The max aptc value for the enrollment
year number The year coverage is being sought for
is_custom boolean Is this a default enrollment grouping provided by an FFM GetEnrollment request, or a custom grouping?
division object
enrollment_groups array
enrollees array
View JSON Schema on GitHub

JSON Schema

cms-gov-extended-enrollment-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/cms-gov/json-schema/cms-gov-extended-enrollment-schema.json",
  "title": "ExtendedEnrollment",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/cms-gov-enrollments-api-openapi.yml#/components/schemas/ExtendedEnrollment",
  "properties": {
    "maxAPTC": {
      "description": "The max aptc value for the enrollment",
      "type": "number",
      "format": "float"
    },
    "year": {
      "x-example": 2019,
      "description": "The year coverage is being sought for",
      "type": "number",
      "format": "integer"
    },
    "is_custom": {
      "description": "Is this a default enrollment grouping provided by an FFM GetEnrollment request, or a custom grouping?",
      "type": "boolean"
    },
    "division": {
      "$ref": "#/$defs/ProductDivisionEnum"
    },
    "enrollment_groups": {
      "items": {
        "properties": {
          "id": {
            "description": "The enrollment group id (uuid)",
            "type": "string",
            "pattern": "^[0-9a-f-]+$"
          },
          "csr": {
            "$ref": "#/$defs/CostSharingReductionEnum"
          },
          "enrollees": {
            "description": "Enrollee ids",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "subscriber_id": {
            "type": "string"
          },
          "relationships": {
            "type": "array",
            "items": {
              "$ref": "#/$defs/RelationshipEdge"
            }
          },
          "effective_date": {
            "description": "Date coverage goes into effect (ISO-8601 YYYY-MM-DD)",
            "type": "string",
            "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$",
            "x-example": "2020-01-01"
          }
        }
      },
      "type": "array"
    },
    "enrollees": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/ExtendedEnrollee"
      }
    }
  },
  "$defs": {
    "Address": {
      "properties": {
        "city": {
          "type": "string"
        },
        "state": {
          "type": "string"
        },
        "street_1": {
          "type": "string"
        },
        "street_2": {
          "type": "string"
        },
        "zipcode": {
          "type": "string"
        },
        "countyfips": {
          "description": "5-digit county FIPS code",
          "type": "string"
        }
      },
      "type": "object"
    },
    "CostSharingReductionEnum": {
      "type": "string",
      "description": "Cost-sharing reduction (CSR)",
      "enum": [
        "Exchange variant (no CSR)",
        "Zero Cost Sharing Plan Variation",
        "Limited Cost Sharing Plan Variation",
        "73% AV Level Silver Plan CSR",
        "87% AV Level Silver Plan CSR",
        "94% AV Level Silver Plan CSR",
        "Non-Exchange variant",
        "Unknown CSR"
      ],
      "properties": {}
    },
    "CurrentEnrollment": {
      "description": "Current/existing enrollment information used to determine tobacco status for CiC enrollments. This will ensure rate calculation is done correctly.",
      "required": [
        "plan_id",
        "effective_date",
        "uses_tobacco"
      ],
      "properties": {
        "plan_id": {
          "$ref": "#/$defs/PlanID"
        },
        "effective_date": {
          "description": "Date plan went into effect (ISO-8601 YYYY-MM-DD)",
          "type": "string",
          "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$",
          "x-example": "2020-01-01"
        },
        "uses_tobacco": {
          "type": "boolean"
        }
      },
      "type": "object"
    },
    "ExtendedEnrollee": {
      "properties": {
        "id": {
          "description": "The enrollee's id (uuid)",
          "type": "string",
          "pattern": "^[a-f0-9-]+$"
        },
        "name": {
          "description": "The enrollee's name",
          "type": "string"
        },
        "gender": {
          "$ref": "#/$defs/GenderEnum"
        },
        "dob": {
          "description": "The enrollee's date of birth (iso8601 date)",
          "type": "string",
          "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
        },
        "location": {
          "$ref": "#/$defs/Address"
        },
        "csr": {
          "$ref": "#/$defs/CostSharingReductionEnum"
        },
        "is_filer": {
          "type": "boolean"
        },
        "effective_age": {
          "type": "integer",
          "description": "Effective age of the enrollee at time of enrollment."
        },
        "has_hardship": {
          "type": "boolean"
        },
        "relationship": {
          "$ref": "#/$defs/Relationship"
        },
        "allowed_metal_levels": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/MetalLevelEnum"
          }
        },
        "allowed_plan_ids": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/PlanID"
          }
        },
        "current_enrollment": {
          "$ref": "#/$defs/CurrentEnrollment"
        }
      }
    },
    "GenderEnum": {
      "enum": [
        "Male",
        "Female"
      ],
      "type": "string"
    },
    "MetalLevelEnum": {
      "enum": [
        "Catastrophic",
        "Silver",
        "Bronze",
        "Gold",
        "Platinum"
      ],
      "type": "string",
      "properties": {}
    },
    "PlanID": {
      "type": "string",
      "pattern": "^[0-9]{5}[A-Z]{2}[0-9]{7}$",
      "properties": {}
    },
    "ProductDivisionEnum": {
      "enum": [
        "HealthCare",
        "Dental"
      ],
      "type": "string"
    },
    "Relationship": {
      "description": "Should match one of the [listed valid relationships](#introduction/more-information-about-households).",
      "type": "string",
      "properties": {}
    },
    "RelationshipEdge": {
      "properties": {
        "super_id": {
          "type": "string",
          "description": "enrollee id"
        },
        "sub_id": {
          "type": "string",
          "description": "enrollee id"
        },
        "relationship": {
          "$ref": "#/$defs/Relationship"
        }
      }
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/cms-gov-extended-enrollment"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.