Table of Contents
In Supportable, a referral’s progress through the Queue stage is tracked by an Queue Progress record. Queue Progress records are associated with a Referral Process Document and contain information about whether the Queue stage has been completed and any Queue Progress Items which were created in the stage. A Queue Progress Item contains the location at which the Person was set to be placed, the scheduled time of placement and whether the placement occurred.
Sample Request #
| Headers | Authorization = Bearer [token] |
| Parameters | None |
| Body | None |
GET https://connect.supportableapp.com/api/referrals/process-documents/
{processDocumentId}/queue-progress
Sample Response JSON #
Status: 200
{
"id": "639966d6375b94cfdaedad7a",
"processDocumentId": "63996443375b94cfdaedad6a",
"subEntityId": "6398b8a6904c0725a6e560f2",
"isCompleted": true,
"queueProgressItems": [
{
"id": "1",
"approval": true,
"stageOutcome": {
"id": "620d0968ca6095ccd3ed310e",
"name": "Admitted"
},
"admissionDate": "2022-12-14T00:00:00.000Z",
"locationId": "63996381375b94cfdaedad5f",
"createdDate": "2022-12-14T06:01:58.268Z"
}
]
}
Notes on Values #
| Attribute | Data Type | Description |
|---|---|---|
| id | string | The unique identifier for the Queue Progress record. |
| processDocumentId | string | The unique identifier for the Referral Process Document with which the Queue Progress record is associated. |
| subEntityId | string | The unique identifier for the Sub-Entity with which the Queue Progress record is associated. |
| isCompleted | boolean | Whether the Queue stage for the referral is completed at this time. (Note: For the Queue stage to be complete, there must be at least one Queue Progress Item with an “Admitted” outcome) |
| queueProgressItems | array of objects | Any Queue Progress Items which have been added to the Queue Progress record. |
| queueProgressItems.id | string | The unique identifier of the Queue Progress Item. In this context, it also corresponds to the order in which the Queue Progress Item was created. |
| queueProgressItems.locationId | string | The unique identifier of the Location at which the Person was set to be placed. |
| queueProgressItems.stageOutcome | object | The outcome of the Queue Progress Item, if any. (Note: If the Queue Progress Item is unresolved or incomplete, this value will be null) |
| queueProgressItems.stageOutcome.id | string | The unique identifier of the outcome. |
| queueProgressItems.stageOutcome.name | string | The name of the outcome. |
| queueProgressItems.admissionDate | datetime | The ISO datetime value, in UTC, for which the placement was scheduled. |
| queueProgressItems.createdDate | datetime | The ISO datetime value, in UTC, at which the Queue Progress Item was created. |
