Table of Contents
When a Person submits a referral to your organization using Supportable’s provided referral form, a Referral Raw Document is created. A Referral Raw Document contains all of the answers to the questions on the referral form as they were answered at the time of submission. These values may be changed over time during the intake process, but they will always remain preserved in their original state in the Referral Raw Document. If more than one service (Offering) is requested by the Person on the referral form, the referral is split into as many Referral Process Documents which are all associated with the one Referral Raw Document.
Sample Request #
| Headers | Authorization = Bearer [token] |
| Parameters | None |
| Body | None |
GET https://connect.supportableapp.com/api/referrals/process-documents/
{processDocumentId}/raw-document
Sample Response JSON #
Status: 200
{
"id": "635187d4ca0b1fdec440a786",
"referenceToken": "20221020173932",
"sections": [
{
"sectionId": "chooseServices",
"sectionHeader": "Choose Services",
"sectionSubHeader": "Let's determine what services you wish to apply for today!",
"questions": [
{
"id": "services",
"label": "Please tell us what service(s) you are looking for today!
You may choose more than one.",
"type": "checkboxList",
"isRequired": true,
"options": [
{
"id": "6398d485904c0725a6e5610f",
"name": "Comprehensive Assessment"
},
{
"id": "6311a1dac42741794219e7bd",
"name": "Diagnostic Assessment"
},
{
"id": "6398c633904c0725a6e560fe",
"name": "Intensive Outpatient Services (IOP)"
}
],
"value": "6398d485904c0725a6e5610f,6311a1dac42741794219e7bd"
},
. . .
],
"subSections": null
},
. . .
],
"subEntity": {
"id": "6398b8a6904c0725a6e560f2",
"status": true,
"name": "DOBIS Recovery"
},
"internal": false
}
Notes on Values #
| Attribute | Data Type | Description |
|---|---|---|
| id | string | The unique identifier of the Referral Raw Document. |
| referenceToken | string | A token, similar to a confirmation number, given to the referent once the referral is submitted, for later reference and lookup. |
| sections | array of objects | The sections (pages) of the referral form. |
| sections.sectionId | string | The unique identifier for the section. |
| sections.sectionHeader | string | The header for the section, as it appeared on the referral form. |
| sections.sectionSubHeader | string | The sub-header for the section, as it appeared on the referral form. |
| sections.questions | array of objects | The questions which appear in the referral form section. |
| sections.questions.id | string | The unique identifier for the question. |
| sections.questions.label | string | The label of the question, as it appeared on the referral form. |
| sections.questions.type | string | The input type of the question, be it a radio, textbox, textarea, etc. |
| sections.questions.isRequired | boolean | Whether an answer to the question was required to proceed to the next section of the referral form. |
| sections.questions.options | array of objects | Options given to the referent to answer the question, if any. The options contained here are dynamic and do not follow a specific schema. |
| sections.questions.value | string | The answer given by the referent. If the question had options, the answer will correspond to one or more of the options given. If not, the answer will appear as it was given by the referent. |
| sections.subSections | array of objects | Any sub-sections that appeared within this section on the referral form. A subSection follows the same schema as a section. A subSection may also contain its own subSections. |
| subentity | object | The sections (pages) of the referral form. |
| subentity.id | string | The unique identifier of the Sub-Entity. |
| subentity.name | string | The name of the Sub-Entity. |
| subentity.status | string | Whether the Sub-Entity is active in Supportable. |
| internal | boolean | Whether the Referral Raw Document was created by someone within the organization. |
