ExtendedEnrollment

Schema for ExtendedEnrollment from CMS Marketplace API

MedicareMedicaidHealthcareHealth InsuranceFHIRFederal GovernmentDrug SpendingProvider DataQuality MeasuresClaims 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

marketplace-extendedenrollment.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ExtendedEnrollment",
  "description": "Schema for ExtendedEnrollment from CMS Marketplace API",
  "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": "#/definitions/ProductDivisionEnum"
    },
    "enrollment_groups": {
      "items": {
        "properties": {
          "id": {
            "description": "The enrollment group id (uuid)",
            "type": "string",
            "pattern": "^[0-9a-f-]+$"
          },
          "csr": {
            "$ref": "#/definitions/CostSharingReductionEnum"
          },
          "enrollees": {
            "description": "Enrollee ids",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "subscriber_id": {
            "type": "string"
          },
          "relationships": {
            "type": "array",
            "items": {
              "$ref": "#/definitions/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": "#/definitions/ExtendedEnrollee"
      }
    }
  }
}