Tour Progress

In Supportable, a referral’s progress through the Tour stage is tracked by an Tour Progress record. Tour Progress records are associated with a Referral Process Document and contain information about whether the Tour stage has been completed and any Tour Progress Items which were created in the stage. A Tour Progress Item contains the date for which a tour was scheduled, the location of the tour, and whether it was attended, rescheduled, etc.

Sample Request #

HeadersAuthorization = Bearer [token]

Sample Response JSON #

Status: 200

  "id": "63996651375b94cfdaedad75",
  "processDocumentId": "63996443375b94cfdaedad6e",
  "subEntityId": "6398b8a6904c0725a6e560f2",
  "isCompleted": true,
  "tourProgressItems": [
      "id": "1",
      "locationId": "6399654f375b94cfdaedad73",
      "stageOutcome": {
        "id": "62823a2723dbf7efb7a0cee7",
        "name": "Attended"
      "tourDate": "2022-12-13T00:00:00.000Z",
      "createdDate": "2022-12-14T05:59:45.275Z"

Notes on Values #

AttributeData TypeDescription
idstringThe unique identifier for the Tour Progress record.
processDocumentIdstringThe unique identifier for the Referral Process Document with which the Tour Progress record is associated.
subEntityIdstringThe unique identifier for the Sub-Entity with which the Tour Progress record is associated.
isCompletedbooleanWhether the Tour stage for the referral is completed at this time.
(Note: For the Tour stage to be complete, there must be at least one Tour Progress Item with an “Admitted” outcome)
tourProgressItemsarray of objectsAny Tour Progress Items which have been added to the Tour Progress record.
tourProgressItems.idstringThe unique identifier of the Tour Progress Item. In this context, it also corresponds to the order in which the Tour Progress Item was created.
tourProgressItems.locationIdstringThe unique identifier of the Location at which the Person was set to be placed.
tourProgressItems.stageOutcomeobjectThe outcome of the Tour Progress Item, if any.
(Note: If the Tour Progress Item is unresolved or incomplete, this value will be null)
tourProgressItems.stageOutcome.idstringThe unique identifier of the outcome.
tourProgressItems.stageOutcome.namestringThe name of the outcome.
tourProgressItems.tourDate datetimeThe ISO datetime value, in UTC, for which the placement was scheduled.
tourProgressItems.createdDatedatetimeThe ISO datetime value, in UTC, at which the Tour Progress Item was created.