tasks

Create a task

Creates a task assigned to a staff member. The server assigns the id, timestamps and the creator; status defaults to New and priority to Medium.

The assignee is notified exactly as they would be for a task created in the app. Requests are not idempotent: retrying a successful call creates a second task.

post/tasks

Request

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

Request body

titlestring required

Short summary of the task. Unstructured clinical free text; may contain PHI.

descriptionstring

Optional detail. Unstructured clinical free text; may contain PHI. Markdown is rendered.

assigneeIdstring uuid required

The staff user to assign the task to. Must be an active staff user.

priority'Low' | 'Medium' | 'High'
status'New' | 'Working' | 'Complete' | 'Won't Do'
dueDatestring date

Date the task is due.

Example request

{
  "title": "Call the pharmacy",
  "assigneeId": "9a5e64b0-0a73-4cb5-ab32-44fea16da4e1",
  "priority": "High",
  "dueDate": "2024-01-31"
}

Response

Task created successfully.

idstring uuid
titlestring
descriptionstring
status'New' | 'Working' | 'Complete' | 'Won't Do'
priority'Low' | 'Medium' | 'High'
assigneeIdstring uuid nullable

The user the task is assigned to, or null if unassigned.

createdByIdstring uuid nullable

The user who created the task, or null if it was created by an automation.

patientIdstring uuid nullable

The client the task is linked to, or null if it is not client-linked.

dueDatestring date nullable

The date the task is due, or null if it has no due date.

createdAtstring date-time
updatedAtstring date-time nullable

When the task was last updated, or null if it has never been updated.

statusUpdatedAtstring date-time nullable

When the task's status last changed, or null if it has never changed.

Example response

{
  "id": "182c2e54-3494-4b85-aba5-038cf539d5bf",
  "title": "Call the pharmacy",
  "description": "Confirm the refill went through.",
  "assigneeId": "9a5e64b0-0a73-4cb5-ab32-44fea16da4e1",
  "dueDate": "2024-01-31",
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-02T00:00:00Z",
  "statusUpdatedAt": "2024-01-02T00:00:00Z"
}

Changes

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