List OASIS assessments
/v1/oasis-assessmentsReturns a page of OASIS assessments. Filters combine with AND. Use next_cursor to fetch the next page. Available to keys belonging to office staff.
Query parameters
Number of objects to return, from 1 to 100.
The next_cursor from the previous page. Send the same filters with it.
Only return assessments of this patient.
Only return assessments with this status.
DraftCompletedExportedAcceptedRejectedInactivatedOnly return objects created after this time (exclusive). ISO 8601 with a time zone.
Only return objects created before this time (exclusive). ISO 8601 with a time zone.
Only return objects last changed after this time (exclusive). ISO 8601 with a time zone. Use it for incremental sync: pass the newest updatedAt you already have.
Only return objects last changed before this time (exclusive). ISO 8601 with a time zone.
Response
200A page of results.
Always list.
The OASIS assessments on this page.
Show item attributesHide item attributes(16)
String representing the object's type. Always oasis_assessment.
Unique identifier of the OASIS assessment.
The patient assessed.
Which OASIS time point this assessment covers.
SOCROCRecertificationTransferDischargeDeathAtHomenullOASIS data set version.
Where the assessment is in its lifecycle.
DraftCompletedExportedAcceptedRejectedInactivatednullDate the assessment was completed (OASIS item M0090).
Start of the care episode.
Date the assessment is due.
Clinician who performed the assessment.
When the assessment was marked complete.
When the assessment was exported for submission.
Correction number; 0 for the original.
Notes on the assessment.
When the OASIS assessment was created.
When the OASIS assessment was last changed.
Pass as cursor to fetch the next page. null on the last page.
Whether another page exists.
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
| Status | Code | Meaning |
|---|---|---|
| 400 | n/a | The request was malformed, a value was invalid, or it contained an unknown field (invalid_request, unknown_field). |
| 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). |
| 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.