Public documentation (Tier 1)Approved
OCRS reporting data dictionary
Field-by-field reference for the public OCRS reporting extract: description, type, requirement class, source, validation and an example for every published field.
- Document version
- 1.0
- Last updated
- 2026-09-08
- Document owner
- OWNER INPUT REQUIRED — DOCUMENT GOVERNANCE
- Applies to
- OCRS 2.4.0 (multi-tenant hosted edition)
- Status
- Approved
- Audience
- Technical evaluators, State agencies, Health systems, Procurement teams
- Evidence source
- src/lib/obcc/state-csv.ts (schema version 2.0.0)
Scope of this document
This is the public reporting schema — the fields OCRS emits to an authorized recipient. It is deliberately not the internal database schema: internal keys, table structures, credentials and implementation columns are not published, and no protected health information is carried by the reporting format at all. The only occupant attribute is an age or the 90+ band; no name, initials, record number, date of birth or diagnosis is ever emitted.
- Required — must be present on every row.
- Conditional — required in defined circumstances (jurisdiction specification, occupied bed, blocked bed, populated date).
- Optional — recorded where available.
- Derived — calculated by OCRS and never submitted.
Fields
| Field | Description | Type | Required? | Source | Validation | Example |
|---|---|---|---|---|---|---|
| facilityId | OCRS Facility ID registered for the facility with the receiving jurisdiction. | Text | Required | Facility record — identifiers | Must be present; submission is blocked when empty. | OR-FAC-004821 |
| organizationName | Legal name of the organization that owns the facility. | Text | Required | Organization record | Must resolve to a named organization in the directory. | Cascade Residential Services |
| facilityName | Canonical facility name as licensed. | Text | Required | Facility record | Must be present on the facility master record. | Cascade House — Salem |
| licenseNumber | Facility licence number. | Text | Conditional | Facility record — licensing | Required when the jurisdiction's specification lists it. | RTH-19204 |
| levelOfCare | Licensed reporting level of care for the facility. | Text | Required | Facility record — licensing | Must be present; supplied by the facility's licensed level of care. | Residential Treatment Home |
| roomName | Room the bed belongs to. | Text | Required | Bed configuration | Must be present on every physical bed row. | Room 4 |
| bedLabel | Label identifying the bed within the room. | Text | Required | Bed configuration | Must be present on every physical bed row. | 4A |
| isActive | Whether the bed is currently part of active licensed capacity. | Boolean (True/False) | Required | Bed configuration | Must be exactly True or False. Inactive physical beds are reported as False rather than omitted, so licensed totals reconcile. | True |
| isOccupied | Whether the bed is held by a resident at the reporting moment. | Boolean (True/False) | Required | Bed state / census snapshot | Must be exactly True or False. | True |
| isBlocked | Whether the bed exists but cannot accept an admission. | Boolean (True/False) | Required | Bed state | Must be exactly True or False. | False |
| isBlockedReason | Reason a bed is unavailable, where a reason is recorded. | Text | Conditional | Bed state — block reason | Populated only when the bed is blocked; empty otherwise. | Maintenance |
| patientAge | Age of the current occupant, or the 90+ band. The only occupant attribute the extract carries — no name, initials, record number, date of birth or diagnosis is ever emitted. | Number or "90+" | Conditional | Bed state | Populated only for an occupied bed; ages above 89 are banded to 90+. | 42 |
| expectedAdmission | Whether an admission is expected into this bed. | Boolean (True/False) | Required | Bed state | Must be exactly True or False. | False |
| expectedAdmissionDate | Date the expected admission is anticipated. | Date (YYYY-MM-DD) | Conditional | Bed state | Must be a valid calendar date in the facility's local time zone when populated. | 2026-09-14 |
| dischargeOrder | Whether a discharge order exists for the current occupant. | Boolean (True/False) | Required | Bed state | Must be exactly True or False. | True |
| dischargeOrderDate | Date recorded on the discharge order. | Date (YYYY-MM-DD) | Conditional | Bed state | Must be a valid calendar date in the facility's local time zone when populated. | 2026-09-11 |
Note: Column order is fixed by the schema version and is never reordered or renamed within a version. A change to the column set, ordering or value encoding requires a new schema version and a release note.
Version history
This document covers a change-managed subject, so every substantive change is versioned with its effective date and the audience it affects.
| Version | Effective date | What changed | Affected audience |
|---|---|---|---|
| 1.0 | 2026-09-08 | First published public data dictionary for extract schema 2.0.0. | Technical evaluators, jurisdictions |