General Assessments API

Endpoints for managing assessments and evaluations.

List Assessments

Get a list of assessments.

Endpoint: GET /v1/assessments
Authentication: Required

Query Parameters

Example Request

GET /v1/assessments?patient_id=1049&status=completed HTTP/1.1
Content-Type: application/json
X-User-Token: your_token_here

Create Assessment

Endpoint: POST /v1/assessments
Authentication: Required

Request Body Parameters

Example Request

POST /v1/assessments HTTP/1.1
Content-Type: application/json
X-User-Token: your_token_here
 
{
  "assessment": {
    "patient_id": 1049,
    "assessment_type": "initial_screening",
    "responses": [
      {
        "question_id": 1,
        "answer": "Sometimes"
      },
      {
        "question_id": 2,
        "answer": "3"
      }
    ],
    "completed_at": "2023-10-27T14:30:00.000Z"
  }
}

Get Assessment Details

Endpoint: GET /v1/assessments/{id}
Authentication: Required

Path Parameters

Update Assessment

Endpoint: PUT /v1/assessments/{id}
Authentication: Required

Path Parameters

Request Body Parameters

Same as Create Assessment endpoint.

Delete Assessment

Endpoint: DELETE /v1/assessments/{id}
Authentication: Required

Path Parameters

Mark Assessment as Complete

Endpoint: PUT /v1/assessments/{id}/mark_as_complete
Authentication: Required

Path Parameters

Outstanding Assessments by Child

Get outstanding assessments grouped by child/patient.

Endpoint: GET /v1/assessments/outstanding_assessments_by_child
Authentication: Required

Query Parameters

Outstanding Assessments

Get all outstanding assessments.

Endpoint: GET /v1/assessments/outstanding_assessments
Authentication: Required

Query Parameters

Public Assessments

Create Public Assessment

Create an assessment without authentication (for public forms).

Endpoint: POST /v1/public_assessments
Authentication: Not required

Request Body Parameters

Example Request

POST /v1/public_assessments HTTP/1.1
Content-Type: application/json
 
{
  "public_assessment": {
    "email": "[email protected]",
    "assessment_type": "screening_questionnaire",
    "responses": [
      {
        "question_id": 1,
        "answer": "Yes"
      },
      {
        "question_id": 2,
        "answer": "Moderate"
      }
    ]
  }
}

Assessment Types

Common assessment types include:

• initial_screening - Initial screening assessment
• follow_up - Follow-up assessment
• progress_evaluation - Progress evaluation
• outcome_measure - Outcome measurement
• risk_assessment - Risk assessment
• behavioral_assessment - Behavioral assessment
• cognitive_assessment - Cognitive assessment

Assessment Status Values

• draft - Assessment started but not completed
• in_progress - Assessment is being taken
• completed - Assessment has been completed
• reviewed - Assessment has been reviewed by clinician
• archived - Assessment has been archived

Response Format

Assessment Response

{
  "id": 123,
  "patient_id": 1049,
  "assessment_type": "initial_screening",
  "status": "completed",
  "score": 85,
  "responses": [
    {
      "question_id": 1,
      "question_text": "How often do you feel anxious?",
      "answer": "Sometimes",
      "score": 2
    }
  ],
  "completed_at": "2023-10-27T14:30:00.000Z",
  "reviewed_at": null,
  "created_at": "2023-10-27T14:00:00.000Z",
  "updated_at": "2023-10-27T14:30:00.000Z"
}

Error Responses

422 Unprocessable Entity

{
  "errors": {
    "patient_id": ["can't be blank"],
    "assessment_type": ["is not included in the list"],
    "responses": ["can't be blank"]
  }
}

404 Not Found

{
  "errors": "Assessment not found"
}

Notes

• Assessments can be completed in multiple sessions (draft status)
• Scores are automatically calculated based on response values
• Public assessments allow anonymous completion for screening purposes
• Outstanding assessments help track compliance with assessment schedules
• Some assessments may require specific qualifications to administer or review