Program

A benefits program (e.g., SNAP, Medicaid) offered in a given jurisdiction.

ProgramBase

An entry in the benefits program registry. Programs are hierarchical via `parent` (e.g., "Colorado SNAP" inherits from "Supplemental Nutrition Assistance Program").

Property	Type	Required	Description
identifiers	Identifiers	Yes	System and cross-system identifiers for this program.
name	string	Yes	The program's name.
parent	ProgramRef	No	The parent program, if any. Null for root-level (e.g., federal) programs.
jurisdiction	JurisdictionBase	No	The jurisdiction in which the program operates.
administeringAgency	ProgramAgency	No	The administering agency.
packages	AppPackageRef[]	No	Application packages that include this program. Server-managed.

Example

{
  "identifiers": {
    "systemId": "30a12e5e-5940-4c08-921c-17a8960fcf4b",
    "otherIds": {
      "benefits_gov": {
        "registry": "benefits_gov",
        "value": "SNAP-CO",
        "description": "Benefits.gov program identifier"
      }
    }
  },
  "name": "Colorado SNAP",
  "parent": {
    "id": "40a12e5e-5940-4c08-921c-17a8960fcf4b",
    "name": "Supplemental Nutrition Assistance Program"
  }
}

JSON Schema

$schema: https://json-schema.org/draft/2020-12/schema
$id: ProgramBase.yaml
type: object
properties:
  identifiers:
    $ref: Identifiers.yaml
    description: System and cross-system identifiers for this program.
  name:
    type: string
    description: The program's name.
  parent:
    $ref: ProgramRef.yaml
    description: The parent program, if any. Null for root-level (e.g., federal) programs.
  jurisdiction:
    $ref: JurisdictionBase.yaml
    description: The jurisdiction in which the program operates.
  administeringAgency:
    $ref: ProgramAgency.yaml
    description: The administering agency.
  packages:
    type: array
    items:
      $ref: AppPackageRef.yaml
    description: Application packages that include this program. Server-managed.
required:
  - identifiers
  - name
examples:
  - identifiers:
      systemId: 30a12e5e-5940-4c08-921c-17a8960fcf4b
      otherIds:
        benefits_gov:
          registry: benefits_gov
          value: SNAP-CO
          description: Benefits.gov program identifier
    name: Colorado SNAP
    parent:
      id: 40a12e5e-5940-4c08-921c-17a8960fcf4b
      name: Supplemental Nutrition Assistance Program
description: |-
  An entry in the benefits program registry. Programs are hierarchical via
  `parent` (e.g., "Colorado SNAP" inherits from "Supplemental Nutrition
  Assistance Program").

TypeSpec

/** An entry in the benefits program registry. Programs are hierarchical via
 * `parent` (e.g., "Colorado SNAP" inherits from "Supplemental Nutrition
 * Assistance Program").
 */
@example(Examples.Program.coloradoSnap)
@Versioning.added(Versions.v0_1)
model ProgramBase {
  /** System and cross-system identifiers for this program. */
  identifiers: Fields.Identifiers;

  /** The program's name. */
  name: string;

  /** The parent program, if any. Null for root-level (e.g., federal) programs. */
  parent?: ProgramRef;

  /** The jurisdiction in which the program operates. */
  jurisdiction?: JurisdictionBase;

  /** The administering agency. */
  administeringAgency?: ProgramAgency;

  /** Application packages that include this program. Server-managed. */
  packages?: AppPackageRef[];
}

ProgramAgency

A government or administrative body responsible for a program. Denormalized onto Program responses; not a standalone resource in v0.1.0.

Property	Type	Required	Description
name	string	Yes	The agency's full name.
code	string	No	A short code or abbreviation for the agency.
parent	object	No	The parent agency, if any.

Example

{
  "name": "Colorado Department of Human Services",
  "code": "CDHS",
  "parent": {
    "name": "State of Colorado",
    "code": "CO"
  }
}

JSON Schema

$schema: https://json-schema.org/draft/2020-12/schema
$id: ProgramAgency.yaml
type: object
properties:
  name:
    type: string
    description: The agency's full name.
  code:
    type: string
    description: A short code or abbreviation for the agency.
  parent:
    type: object
    properties:
      name:
        type: string
        description: The parent agency's name.
      code:
        type: string
        description: The parent agency's short code or abbreviation.
    required:
      - name
    description: The parent agency, if any.
required:
  - name
examples:
  - name: Colorado Department of Human Services
    code: CDHS
    parent:
      name: State of Colorado
      code: CO
description: |-
  A government or administrative body responsible for a program.
  Denormalized onto Program responses; not a standalone resource in v0.1.0.

TypeSpec

/** A government or administrative body responsible for a program.
 * Denormalized onto Program responses; not a standalone resource in v0.1.0.
 */
@example(Examples.Program.agency)
@Versioning.added(Versions.v0_1)
model ProgramAgency {
  /** The agency's full name. */
  name: string;

  /** A short code or abbreviation for the agency. */
  code?: string;

  /** The parent agency, if any. */
  parent?: {
    /** The parent agency's name. */
    name: string;

    /** The parent agency's short code or abbreviation. */
    code?: string;
  };
}

ProgramRef

A denormalized reference to a program. Carries enough information to display without a separate lookup; clients follow the `id` to `GET /programs/{programId}` for the full record. Used for parent references, lists of related programs, and embedded program references on other models (e.g., the programs included in an AppPackage).

Property	Type	Required	Description
id	uuid	Yes	The program's unique identifier.
name	string	Yes	Human-readable display name.

Example

{
  "id": "30a12e5e-5940-4c08-921c-17a8960fcf4b",
  "name": "string"
}

JSON Schema

$schema: https://json-schema.org/draft/2020-12/schema
$id: ProgramRef.yaml
type: object
properties:
  id:
    $ref: uuid.yaml
    description: The program's unique identifier.
  name:
    type: string
    description: Human-readable display name.
required:
  - id
  - name
description: |-
  A denormalized reference to a program. Carries enough information to
  display without a separate lookup; clients follow the `id` to
  `GET /programs/{programId}` for the full record. Used for parent
  references, lists of related programs, and embedded program references on
  other models (e.g., the programs included in an AppPackage).

TypeSpec

/** A denormalized reference to a program. Carries enough information to
 * display without a separate lookup; clients follow the `id` to
 * `GET /programs/{programId}` for the full record. Used for parent
 * references, lists of related programs, and embedded program references on
 * other models (e.g., the programs included in an AppPackage).
 */
@Versioning.added(Versions.v0_1)
model ProgramRef {
  /** The program's unique identifier. */
  id: Types.uuid;

  /** Human-readable display name. */
  name: string;
}