Centers for Medicare and Medicaid Services · Schema

Person

Schema for Person from CMS Marketplace API

MedicareMedicaidHealthcareHealth InsuranceFHIRFederal GovernmentDrug SpendingProvider DataQuality MeasuresClaims Data

Properties

Name Type Description
age number required if dob not provided
dob string A person's date of birth (YYYY-MM-DD) required if age not provided
has_mec boolean has minimum essential coverage
is_parent boolean
is_pregnant boolean Indicates whether the individual is pregnant or not. If this is true and `pregnant_with` is not provided, `pregnant_with` is assumed to be 1.
pregnant_with number The number of expected children from a pregnancy. If this value is > 0, `is_pregnant` is assumed to be true, even if specified otherwise.
uses_tobacco boolean
last_tobacco_use_date string The last date of regular tobacco use (YYYY-MM-DD)
gender object
utilization_level object
relationship object
does_not_cohabitate boolean
aptc_eligible boolean is the given person eligible for APTC
current_enrollment object
View JSON Schema on GitHub

JSON Schema

marketplace-person.json Raw ↑ 
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Person",
  "description": "Schema for Person from CMS Marketplace API",
  "properties": {
    "age": {
      "format": "integer",
      "type": "number",
      "description": "required if dob not provided"
    },
    "dob": {
      "description": "A person's date of birth (YYYY-MM-DD) required if age not provided",
      "type": "string",
      "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$",
      "x-example": "2020-01-01"
    },
    "has_mec": {
      "description": "has minimum essential coverage",
      "type": "boolean"
    },
    "is_parent": {
      "type": "boolean"
    },
    "is_pregnant": {
      "description": "Indicates whether the individual is pregnant or not. If this is true and `pregnant_with` is not provided, `pregnant_with` is assumed to be 1.",
      "type": "boolean"
    },
    "pregnant_with": {
      "description": "The number of expected children from a pregnancy. If this value is > 0, `is_pregnant` is assumed to be true, even if specified otherwise.",
      "type": "number"
    },
    "uses_tobacco": {
      "type": "boolean"
    },
    "last_tobacco_use_date": {
      "description": "The last date of regular tobacco use (YYYY-MM-DD)",
      "type": "string",
      "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
    },
    "gender": {
      "$ref": "#/definitions/GenderEnum"
    },
    "utilization_level": {
      "$ref": "#/definitions/UtilizationEnum"
    },
    "relationship": {
      "$ref": "#/definitions/Relationship"
    },
    "does_not_cohabitate": {
      "type": "boolean"
    },
    "aptc_eligible": {
      "description": "is the given person eligible for APTC",
      "type": "boolean"
    },
    "current_enrollment": {
      "$ref": "#/definitions/CurrentEnrollment"
    }
  },
  "type": "object",
  "required": [
    "age",
    "dob"
  ]
}