Table of Contents
In Supportable, a referral’s progress through the Authorization stage is tracked by an Authorization Progress record. Authorization Progress records are associated with a Referral Process Document and contain information about whether the Authorization stage has been completed and any Authorization Progress Items which were created in the stage. An Authorization Progress Item contains the date on which an authorization was requested, when it was received back by the intake team, as well as information about whether the authorization was approved or denied.
Sample Request #
| Headers | Authorization = Bearer [token] |
| Parameters | None |
| Body | None |
GET https://connect.supportableapp.com/api/referrals/process-documents/
{processDocumentId}/authorization-progress
Sample Response JSON #
Status: 200
{
"id": "639966cb375b94cfdaedad79",
"processDocumentId": "63996443375b94cfdaedad6a",
"subEntityId": "6398b8a6904c0725a6e560f2",
"isCompleted": true,
"authorizationProgressItems": [
{
"id": "1",
"stageOutcome": {
"id": "620417324d1ca9cfa472d417",
"name": "Approved"
},
"requestedDate": "2022-12-14T00:00:00.000Z",
"responseDate": "2022-12-14T00:00:00.000Z",
"createdDate": "2022-12-14T06:01:47.822Z"
}
],
"authNotNeeded": false
}
Notes on Values #
| Attribute | Data Type | Description |
|---|---|---|
| id | string | The unique identifier for the Authorization Progress record. |
| processDocumentId | string | The unique identifier for the Referral Process Document with which the Authorization Progress record is associated. |
| subEntityId | string | The unique identifier for the Sub-Entity with which the Authorization Progress record is associated. |
| isCompleted | boolean | Whether the Authorization stage for the referral is completed at this time. (Note: For the Authorization stage to be complete, there must be at least one Authorization Progress Item with an “Admitted” outcome) |
| authorizationProgressItems | array of objects | Any Authorization Progress Items which have been added to the Authorization Progress record. |
| authorizationProgressItems.id | string | The unique identifier of the Authorization Progress Item. In this context, it also corresponds to the order in which the Authorization Progress Item was created. |
| authorizationProgressItems.stageOutcome | object | The outcome of the Authorization Progress Item, if any. (Note: If the Authorization Progress Item is unresolved or incomplete, this value will be null) |
| authorizationProgressItems.stageOutcome.id | string | The unique identifier of the outcome. |
| authorizationProgressItems.stageOutcome.name | string | The name of the outcome. |
| authorizationProgressItems.requestedDate | datetime | The ISO datetime value, in UTC, at which the authorization was requested by the intake team. |
| authorizationProgressItems.responseDate | datetime | The ISO datetime value, in UTC, at which the authorization response was received by the intake team. |
| authorizationProgressItems.createdDate | datetime | The ISO datetime value, in UTC, at which the Authorization Progress Item was created. |
| authNotNeeded | boolean | Whether an authorization is needed for the Authorization stage on the referral, as indicated by the intake team. (Note: A value of null or false indicates that the authorization is required, and a value of true will indicate the authorization is not needed and the Authorization Progress record will be complete) |
