programs

Create a clinic program

Creates a clinic program. Requires name, programType, and at least one levelOfCare entry. The server assigns the program ID; client-supplied id values and other unknown fields are rejected. levelOfCare entries must be exact catalog strings, unique, and compatible with programType. facilityId is optional.

post/programs

Request

  • Base URL: https://api.ritten.io/v1
  • URL: https://api.ritten.io/v1/programs
  • Auth: none declared

Request body

namestring required

Program name. Leading and trailing whitespace is trimmed.

facilityIdstring uuid nullable

Optional active facility ID to associate with the program.

programType'Clinical' | 'Additional Service' required
levelOfCareLevelOfCare[] required

Exact catalog level-of-care values. Entries must be unique and compatible with programType (Clinical programs require clinical LOCs; Additional Service programs require non-clinical LOCs).

Example request

{
  "name": "Residential Treatment",
  "programType": "Clinical",
  "levelOfCare": [
    "Clinically Managed High-Intensity Residential Services (3.5)"
  ],
  "facilityId": "182c2e54-3494-4b85-aba5-038cf539d5bf"
}

Response

Program created successfully.

idstring uuid
namestring
programType'Clinical' | 'Additional Service'
levelOfCareLevelOfCare[]
createdAtstring date-time

Example response

{
  "id": "182c2e54-3494-4b85-aba5-038cf539d5bf",
  "name": "Residential",
  "createdAt": "2024-01-01T00:00:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.