Skip to content

Referral

CodeNameDescriptionType
entityIdEntity IDAuto-generated when the record is created.string
requestDateRequest DateDate when the referral request was made.date
statusReferral StatusDefaults to New at creation and changes to Sent after sending.string
lastChangeStatusTimeChange Status DateDate and time when status was last changed.dateTime
lastChangeStatusByChange Status ByUser who last changed the referral status.string
data.typeReferral TypeDetermined by the referral request type.string
createdReferral Created DatePopulated with the creation date.date
createdByReferral Created ByPopulated with the user who created the referral.string
data.sentDateReferral Sent DateEmpty at creation; populated when the referral is sent.date
data.sentByReferral Sent ByEmpty at creation; populated with the sender when sent.string
data.deliveryReferral DeliveryFor agency add referral, default is Email delivery; for parent search, default is Searched results.string
data.parent.emailReferral Parent EmailCopied from the parent referral request email.string
data.parent.phoneNumberReferral Parent PhoneCopied from the parent referral request phone number.string
data.actionReferral ActionEmpty at creation; records actions such as Profile Viewed after parent interaction.string
data.actionDateReferral Action DateTimestamp of the recorded action (for example, Profile Viewed).date
data.referralRequest._idReferral Request IDPopulated with the referral request ID at generation.string
data.referralRequest.entityIdReferral Request Entity IDEntity ID of the referral request.string
data.referralRequest.assistedTypeReferral Request Assisted TypeAssisted type from the referral request.string
data.provider._idProvider IDID of the recommended provider.string
data.provider.entityIdProvider Entity IDEntity ID of the recommended provider.string
data.provider.profile.programNameProvider Profile Program NameProfile program name of the recommended provider.string
data.provider.profile.emailProvider Profile EmailProfile email of the recommended provider.string
data.provider.profile.phoneNumberProvider Profile PhoneProfile phone number of the recommended provider.string
data.provider.profile.entityIdProvider Profile Entity IDProfile entity ID of the recommended provider.string
data.notesReferral NotesEmpty at creation; can be edited by agency before sending.string
updateDateUpdated Info DateDate and time when info update occurred.dateTime
updateByUpdate Info ByUser who updated referral info.string
modifiedUpdated DateDate and time of the latest modification.dateTime
modifiedByUpdated ByUser who performed the latest modification.string