AveeCare

Retrieve an OASIS assessment

get/v1/oasis-assessments/{id}

Returns one OASIS assessment by ID. Available to keys belonging to office staff.

Authorization

Authorization: Bearer ak_...requiredscope: read

An AveeCare API key created in Settings → API Keys. A read or read + write key can call this endpoint. About authentication

Path parameters

id
stringrequired

ID of the OASIS assessment.

Response

200

The OASIS assessment.

object
stringread-only

String representing the object's type. Always oasis_assessment.

id
stringread-only

Unique identifier of the OASIS assessment.

patientId
string | nullread-onlymax length 64

The patient assessed.

timepoint
string | nullread-only

Which OASIS time point this assessment covers.

One ofSOCROCRecertificationTransferDischargeDeathAtHomenull
specVersion
string | nullread-onlymax length 2000

OASIS data set version.

status
string | nullread-only

Where the assessment is in its lifecycle.

One ofDraftCompletedExportedAcceptedRejectedInactivatednull
m0090CompletedDate
string · date | nullread-only

Date the assessment was completed (OASIS item M0090).

episodeStartDate
string · date | nullread-only

Start of the care episode.

targetDate
string · date | nullread-only

Date the assessment is due.

assessorName
string | nullread-onlymax length 2000

Clinician who performed the assessment.

completedAt
string · date-time | nullread-only

When the assessment was marked complete.

exportedAt
string · date-time | nullread-only

When the assessment was exported for submission.

correctionNumber
integer | nullread-only

Correction number; 0 for the original.

notes
string | nullread-onlymax length 20000

Notes on the assessment.

createdAt
string · date-time | nullread-only

When the OASIS assessment was created.

updatedAt
string · date-time | nullread-only

When the OASIS assessment was last changed.

Response headers

Request-IdstringUnique ID of this request. Quote it when contacting support.
RateLimit-LimitintegerRequests allowed in the current window.
RateLimit-RemainingintegerRequests left in the current window.
RateLimit-ResetintegerSeconds until the window resets.

Errors

StatusCodeMeaning
401
n/a
The API key is missing, malformed, expired or revoked (unauthorized).
403
n/a
The key is read-only (insufficient_scope), or its user's role cannot do this (forbidden).
404
n/a
No such object, or it is not visible to this key (not_found).
429
n/a
Too many requests (rate_limited). Wait for Retry-After seconds.
500
n/a
Something went wrong on our side (internal_error). Retry, and quote the request ID if it persists.

Every error uses the same body. See Errors for the full list of codes.