Skip to main content
Development Note: This is a prototype page testing an alternative layout for schema field references. It uses Mintlify’s ResponseField component (card/list style) instead of the 6-column markdown tables used on the standard CLIENT page. The goal is to compare readability, width, and mobile experience before deciding whether to adopt this layout across all schema pages.
Record Type: CLI | Version: CoBHRM 2026-Q3 | Parent: None | Children: ADMISSION

Overview

The CLIENT schema captures core demographic information for individuals receiving behavioral health services. This is the root record type - all other records reference a client through the BHASO_CLIENT_IDENTIFIER.
Transaction Types: All record types support Add (A), Update (U), and Replace (R) transactions. See Transaction Types for details.

1. Schema Reference

Identifier Fields

x(3)
required
Record Type — Must be CLI, exact and case-sensitive.
x(1)
required
Transaction Type — A (Add), U (Update), or R (Replace). See Transaction Types.
x(-)
required
Client Identifier — Alphanumeric. Unique client ID from the BHASO system.
date
required
Effective Date — Format YYYY-MM-DD. Determines most recent record.
x(7)
Colorado PEAK State ID — Pattern X999999. Also the Medicaid ID. Required.
9(10)
TRAILS ID — 10-digit number. Required if CHILD_WELFARE_INVOLVEMENT = 1.
Conditional
x(-)
Verato Identifier — Alphanumeric. Can be blank for new clients; use existing Verato ID if supplied by BHA.
Conditional
x(41)
BHA Identifier — Pattern BHRM-{UUID}. Data conversion field for legacy records.

Demographic Fields

date
required
Date of Birth — Format YYYY-MM-DD. Must be before record creation; age cannot exceed 120 years.
x(50)
required
Last Name — Text. Regex: [\p{L} -']+
x(50)
required
First Name — Text. Regex: [\p{L} -']+
x(50)
Middle Name/Initial — Text. Regex: [\p{L} -']?
x(10)
Name Suffix — Text. Regex: [\p{L} -']+
x(12)
Social Security Number — Format 999-99-9999. Highly recommended. Special values: 000-00-0000 = No SSN, 777-77-7777 = Client Refused, 999-99-9999 = Unknown (Withdrawal Management only).
9(2)
required
Sex at Birth — Numeric code (e.g., 01, 02). See Sex at Birth. Drives pregnancy/postpartum logic.
9(2)
Gender Identity — See Gender Identity. Optional if Sex at Birth is provided.
9(2)
required
Sexual Orientation — See Sexual Orientation.
x(50)
required
Race Codes — See Race Codes. Multi-value, semicolon+space (; ) delimited.
9(2)
required
Ethnicity — See Ethnicity Codes.
9(2)
Household Language — See Household Language. Triggers Communication Accommodations if not English.
x(100)
required
Disability Codes — See Disability Codes. Multi-value, semicolon+space (; ) delimited.
bit
required
Veteran Status — 1 / 0. Required for age 18 or older; use 0 for clients under 18.
bit
Child Welfare Involvement — 1 / 0. If 1, TRAILS_IDENTIFIER is required.

Location Fields

9(2)
required
County of Residence — 2-digit code. See Counties. Use county of location if houseless. 77 = Out of State, 99 = Unknown (WM only).
x(10)
Zip Code of Residence — Format 99999 or 99999-9999. Required unless County is 77 (Out of State) or 99 (Unknown).
Conditional
x(100)
Last Known Address Line 1 — Text. Null for homeless/houseless and Out of State.
x(100)
Last Known Address Line 2 — Text. Null for homeless/houseless and Out of State.
x(100)
Last Known City — Text. Null for homeless/houseless and Out of State.
9(1)
RAE Region — 1-4. Required if any part of admission treatment is Medicaid-funded.
Conditional

System Metadata Fields

These fields are required in every submission and track record creation and modification:

2. Examples

Minimal Valid Example

Only required fields populated. This is an adult male client in Denver with no disabilities.

Complete Example

All fields populated. Female client with Medicaid, multiple races, child welfare involvement, and full address.

Edge Cases

Multi-value race fields (semicolon-space delimited), international characters in name, and an out-of-state client.
The client above is out-of-state (COUNTY_RESIDENCE = 77), so ZIPCODE_RESIDENCE is not required. The SSN 000-00-0000 indicates “No SSN.” International characters like ü and ç are supported via UTF-8 encoding.
Recommendation — This section contains guidance developed by the documentation team to supplement the CoBHRM specification. Reviewers should evaluate whether to adopt, modify, or remove this content.

Invalid Example with Errors


3. Template

View CLIENT Template

CLIENT schema template with headers and sample row

4. Parsing Rules

CSV Parsing Rules

See File Format Requirements for full details on encoding, quoting, data types, and null handling.
Multi-value delimiter: RACE_CODES and DISABILITY_CODES use semicolon + space (; ) to separate multiple values within a single field.

5. Update Semantics

Primary Key

BHASO_CLIENT_IDENTIFIER + EFFECTIVE_DATE

Transaction Types

Idempotency

  • Most recent record determined by EFFECTIVE_DATE
  • System uses SCD Type 2 - all historical records retained
  • Query for “current” client returns record with latest EFFECTIVE_DATE

Last modified on March 26, 2026