Skip to main content
Documentation Center

OCRS documentation

Public documentation written so a facility, provider organization, county, state agency, health system, procurement team or technical evaluator can answer architecture, reporting, permission and implementation questions without scheduling a meeting. Every document names its version, the date it was last reviewed, its owner, the edition it applies to and whether it is approved.

Approved public documents
12
Documentation set reviewed
2026-09-08
Applies to
OCRS 2.4.0 (multi-tenant hosted edition)
Document owner
OWNER INPUT REQUIRED — DOCUMENT GOVERNANCE

Tier 1 — public documentation

Everything below is publicly available. Nothing is published ahead of the implementation it describes, and where an owner decision has not been made the document says so instead of filling the gap.

Overview

What OCRS is, who uses it, and the boundary of the hosted service.

Approved

OCRS platform overview

What the Occupancy & Capacity Reporting System does, who uses it, and where the boundary of the hosted service sits.

Version
Version 1.0 · Last updated 2026-09-08
Audience
Facilities, Provider organizations, State agencies, Counties, Health systems, Procurement teams, Technical evaluators
Approved

OCRS glossary and canonical terminology

The approved OCRS vocabulary: what each term means, what it must not be confused with, which wording is withdrawn, and the verified difference between platform availability, census updates, submissions, notifications, delivery and retries.

Version
Version 1.0 · Last updated 2026-09-08
Audience
Procurement teams, State agencies, Counties, Provider organizations, Facilities, Implementation teams, Technical evaluators

Architecture & data flow

How reporting information moves from a facility to an authorized jurisdiction recipient.

Approved

Reporting architecture and data flow

The authoritative Facility → OCRS → State/Jurisdiction reporting model, the role of organization aggregation, and a procurement-level data-flow diagram.

Version
Version 1.0 · Last updated 2026-09-08
Audience
Technical evaluators, State agencies, Counties, Procurement teams

Occupancy & capacity model

Bed states, licensed capacity, census snapshots and the values calculated from them.

Approved

Occupancy & capacity data model

Licensed capacity, bed states, block reasons, expected admissions and discharge orders, census snapshots and reporting periods — with physical bed state kept distinct from calculated reporting values.

Version
Version 1.0 · Last updated 2026-09-08
Audience
Technical evaluators, State agencies, Provider organizations

Reporting & validation

What a submission must satisfy before it is accepted, and the published extract schema.

Approved

Reporting and validation rules

What a facility must satisfy before a report can be accepted: required identifiers and fields, valid bed states, capacity constraints, date validation, facility configuration, duplicate handling, corrections and failure behaviour.

Version
Version 1.0 · Last updated 2026-09-08
Audience
Provider organizations, State agencies, Technical evaluators
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.

Version
Version 1.0 · Last updated 2026-09-08
Audience
Technical evaluators, State agencies, Health systems, Procurement teams

Roles & permissions

The implemented role registry and what each role may do.

Approved

Roles and permissions

The implemented OCRS role registry, what each role may do across facility data, census, reports, users, configuration and visibility, and how authorization is enforced.

Version
Version 1.0 · Last updated 2026-09-08
Audience
Procurement teams, Technical evaluators, Security reviewers, State agencies

Data, history & exports

Census history, audit records, exports, retrieval and account termination.

Approved

Data, history and exports

How census history, reporting history, audit records and exports behave; what happens to data on account termination; and which retention decisions are still awaiting owner policy.

Version
Version 1.0 · Last updated 2026-09-08
Audience
Procurement teams, State agencies, Provider organizations, Technical evaluators

Integrations

Interoperability capabilities and the actual implementation status of each.

Approved

Integrations and interoperability status

An honest status list for every OCRS interoperability capability: what is available in production today, what is configured, and what is only planned.

Version
Version 1.0 · Last updated 2026-09-08
Audience
Technical evaluators, Health systems, State agencies, Procurement teams

Implementation

What a customer must decide or provide before an OCRS deployment can go live.

Approved

Implementation and onboarding prerequisites

What a prospective customer must decide or provide before an OCRS deployment can go live, and which responsibilities sit with the customer versus OCRS.

Version
Version 1.0 · Last updated 2026-09-08
Audience
Procurement teams, Provider organizations, State agencies, Counties

Security & privacy

Authentication, authorization, tenant separation and auditability, bounded by evidence.

Approved

Security and privacy overview

High-level authentication, authorization, tenant separation, auditability and data-handling behaviour, stated only to the extent the implementation and the Claims & Evidence Register support it.

Version
Version 1.0 · Last updated 2026-09-08
Audience
Security reviewers, Procurement teams, Technical evaluators

Operations

Support windows, scheduled reporting operations and what OCRS does not publish.

Approved

Operations, support and status

How scheduled reporting runs, what the published support window and initial-response target mean, and what OCRS deliberately does not publish about service status.

Version
Version 1.0 · Last updated 2026-09-08
Audience
Provider organizations, State agencies, Procurement teams

Release notes

Product change history for reporting, validation, roles and exports.

In Development

OCRS release notes

Versioned record of product changes affecting the reporting schema, validation, roles, permissions, integrations, retention and exports.

Version
Version 0.1 · Last updated 2026-09-08
Audience
All customers, Technical evaluators

In Development — not yet published

Technical & procurement resources

The full evaluation set in one place. Items with no link are either in development or deliberately not published — they are listed so the gap is visible rather than hidden.

Tier 2 — controlled documentation

Deeper material is released only through an approved due-diligence or security review. These documents are not published, because publishing them would enlarge the OCRS attack surface without helping an evaluation. Where no approved evidence exists yet, that is stated plainly rather than implied.

  • Detailed security architecture

    Approved

    Component-level architecture, trust boundaries, secret handling and administrative access paths.

    Available during qualified security/procurement review Publishing it would enlarge the attack surface without helping an evaluation.

  • Authorization control documentation (row-level policy implementation)

    Approved

    Table-by-table access policies, predicates and the tests that prove them.

    Available during qualified security/procurement review Policy predicates are exploitable detail; the public matrix states the effect instead.

  • Infrastructure and network diagrams

    Approved

    Hosting topology, environments, hostnames and network paths.

    Available during qualified security/procurement review Infrastructure detail is never published.

  • Internal control and verification evidence

    Approved

    Executed verification runs for permissions, tenant isolation, reporting and readiness gates.

    Available during qualified security/procurement review Released under review so results are read with their scope and environment.

  • Security questionnaire responses

    Under Review

    Completed responses to a reviewer's own security or vendor-risk questionnaire.

    Available during qualified security/procurement review Prepared per reviewer.

  • Penetration-testing evidence

    In Development

    Independent penetration-test scope, findings and remediation evidence.

    Not available — no approved evidence exists yet No engagement has been completed, so no evidence exists to release.

  • Disaster-recovery evidence

    In Development

    Recovery objectives, rehearsal records and restoration evidence.

    Not available — no approved evidence exists yet Recovery objectives have not been approved, so nothing is published or released.

Product reference documentation

Operational reference material for people using OCRS day to day, alongside the guides and training courses in the Resource Center.

Published

Automated reporting and delivery

The recurring reporting schedule, what triggers an immediate report, how delivery is logged, and how repeated runs are kept idempotent.

Resource type
Documentation
Audience
Organization administrators, State administrators
Length
7 min read
Published

Roles, permissions and scope

Every OCRS role, what it can read and write, how scope limits it to a jurisdiction, organization or facility, and how isolation is enforced.

Resource type
Documentation
Audience
Organization administrators, State administrators, Security reviewers
Length
9 min read
In development

Data exports and file formats

Field-by-field reference for occupancy exports and the state bed extract file layout.

Resource type
Documentation
Audience
Organization administrators, State administrators
In development

Submission validation reference

Every validation rule applied to a census submission and the message it produces.

Resource type
Documentation
Audience
Facility managers, Organization administrators
In development

Integration overview

How an external system will be able to read published capacity data once the OCRS API is released.

Resource type
Documentation
Audience
Technical evaluators, Procurement reviewers