Skip to main content

Facilities

warning

Satxuma is still under active development. It is not yet HIPAA compliant and should only be used with dummy data.

A facility represents a location where therapy services are provided. This could be a hospital, outpatient clinic, skilled nursing facility, or any other type of care site. Facilities are associated with an organization and can have contracts with payors to manage therapy coverage.

Data model​

Satxuma stores facilities under an organization:

A single facility can have 0 or more (non-concurrent) contracts.

Furthermore, every admission references a facility.

Facility types​

Every facility has a type. Valid types include:

  • Assisted living
  • Hospice
  • Hospital
  • Independent living
  • Inpatient rehab
  • Long term acute care hospital
  • Outpatient clinic
  • Skilled nursing

Facility type can be used to enforce rules, categorize services, and help with reporting.

Properties​

A Facility has the following properties:

  • id (string) — A unique identifier for the facility.
  • name (string) — The name of the facility. Must be a non-empty string.
  • type (FacilityType) — The type of facility. Valid types:
    • Assisted living
    • Hospice
    • Hospital
    • Independent living
    • Inpatient rehab
    • Long term acute care hospital
    • Outpatient clinic
    • Skilled nursing
  • address (string) — Street address of the facility.
  • city (string) — City where the facility is located.
  • stateId (StateId) — State where the facility is located.
  • county (IdPlusName<number> | null) — Optional county information.
  • postalCode (string) — Postal/ZIP code of the facility.
  • timeZone (TimeZone) — IANA time zone for the facility.
  • organizationId (string) — The ID of the parent organization.
  • npi (string) — National Provider Identifier, if applicable.
  • medicareNumber (string) — Medicare facility number, if applicable.
  • federalTaxId (string) — Federal tax ID number.
  • pbj (string) — Payroll-Based Journal ID, if applicable.
  • contracts (ContractInFacilityDoc[]) — Contracts with payors or organizations.
  • admissions (AdmissionInFacilityDoc[]) — Admissions associated with this facility.
  • tags (string[]) — Optional tags to categorize or label the facility.
  • notes (string) — Optional free-text notes about the facility.
  • isActive (true) — Indicates whether the facility is currently active.

Examples​

Example 1: Outpatient Clinic​

{
  "id": "f001",
  "name": "Sunrise Outpatient Clinic",
  "type": "Outpatient clinic",
  "address": "123 Main St",
  "city": "Austin",
  "stateId": "TX",
  "county": null,
  "postalCode": "78701",
  "timeZone": "America/Chicago",
  "organizationId": "org123",
  "npi": "1234567890",
  "medicareNumber": "M12345",
  "federalTaxId": "12-3456789",
  "pbj": "PBJ001",
  "contracts": [],
  "admissions": [],
  "tags": ["outpatient", "physical therapy"],
  "notes": "Newly opened clinic.",
  "isActive": true
}

Example 2: Skilled Nursing Facility​

{
  "id": "f002",
  "name": "Greenwood Skilled Nursing",
  "type": "Skilled nursing",
  "address": "456 Elm St",
  "city": "Dallas",
  "stateId": "TX",
  "county": { "id": 101, "name": "Dallas County" },
  "postalCode": "75201",
  "timeZone": "America/Chicago",
  "organizationId": "org123",
  "npi": "0987654321",
  "medicareNumber": "M67890",
  "federalTaxId": "98-7654321",
  "pbj": "PBJ002",
  "contracts": [],
  "admissions": [],
  "tags": ["long-term care"],
  "notes": "",
  "isActive": true
}