Centers for Medicare and Medicaid Services · Schema

ExtendedEnrollee

Schema for ExtendedEnrollee from CMS Marketplace API

MedicareMedicaidHealthcareHealth InsuranceFHIRFederal GovernmentDrug SpendingProvider DataQuality MeasuresClaims Data

Properties

Name	Type	Description
id	string	The enrollee's id (uuid)
name	string	The enrollee's name
gender	object
dob	string	The enrollee's date of birth (iso8601 date)
location	object
csr	object
is_filer	boolean
effective_age	integer	Effective age of the enrollee at time of enrollment.
has_hardship	boolean
relationship	object
allowed_metal_levels	array
allowed_plan_ids	array
current_enrollment	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ExtendedEnrollee",
  "description": "Schema for ExtendedEnrollee from CMS Marketplace API",
  "properties": {
    "id": {
      "description": "The enrollee's id (uuid)",
      "type": "string",
      "pattern": "^[a-f0-9-]+$"
    },
    "name": {
      "description": "The enrollee's name",
      "type": "string"
    },
    "gender": {
      "$ref": "#/definitions/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": "#/definitions/Address"
    },
    "csr": {
      "$ref": "#/definitions/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": "#/definitions/Relationship"
    },
    "allowed_metal_levels": {
      "type": "array",
      "items": {
        "$ref": "#/definitions/MetalLevelEnum"
      }
    },
    "allowed_plan_ids": {
      "type": "array",
      "items": {
        "$ref": "#/definitions/PlanID"
      }
    },
    "current_enrollment": {
      "$ref": "#/definitions/CurrentEnrollment"
    }
  }
}