Follow-Up

Event wrapper values

Each time a consultation is created

Field	Value(s)
`eventType`	followup
`operation`	create

Each time a follow-up status changed.

Field	Value(s)
`eventType`	followup
`operation`	update

Data Schema

{
  "followup": {
    "followupKey": "UUID",
    "patientKey": "UUID",
    "externalPatientKeys": [
      {
        "subSystem": "STRING",
        "key": "STRING"
      }
    ],
    "tenantKey": "UUID",
    "followupAnsweredAt": "UTC_TIMESTAMP",
    "followupScheduledAt": "UTC_TIMESTAMP",
    "followupFinishedAt": "UTC_TIMESTAMP",
    "recurring": "BOOLEAN",
    "followupStatus": {
      "id": "STRING",
      "en": "ENGLISH_STRING",
      "fr": "FRENCH_STRING"
    },
    "followupMethod": {
      "id": "STRING",
      "en": "ENGLISH_STRING",
      "fr": "FRENCH_STRING"
    },
    "metadata": "STRING",
    "followupReason": {
      "en": "ENGLISH_STRING",
      "fr": "FRENCH_STRING"
    },
    "customFollowupReason": "STRING",
    "followupSummary": {
      "en": "ENGLISH_STRING",
      "fr": "FRENCH_STRING"
    },
    "billableDinList": ["STRING"],
    "smsDeliveryStatus": "STRING",
    "emailDeliveryStatus": "STRING",
    "attachments": ["STRING"],
    "followUpReminderList": [
      {
        "followUpReminderSentAt": "YYYY-MM-DD HH:MM:SS.mmm"
      },
      {
        "followUpReminderSentAt": "YYYY-MM-DD HH:MM:SS.mmm"
      }
    ]
  }
}

Field	Type	Description
followupKey	UUID	This is the follow-up unique identifier.
patientKey	UUID	This is Empego’s patient unique identifier.
externalPatientKey	External Patient Key	This JSON Object refers to the external system that shares its unique identifier with Empego.
tenantKey	UUID	This is Empego’s tenant’s unique identifier.
followupAnsweredAt	UTC Timestamp	Timestamp for when the follow-up was answered. The format is `yyyy-MM-dd HH:mm:ss.SSS`.
followupScheduledAt	UTC Timestamp	Timestamp for when the follow-up is scheduled to happen. The format is `yyyy-MM-dd HH:mm:ss.SSS`.
followupFinishedAt	UTC Timestamp	Timestamp for when the follow-up was finished. The format is `yyyy-MM-dd HH:mm:ss.SSS`.
recurring	BOOLEAN	A field that gives information about the recurrence of the follow-up.
followupStatus	Identifiable Localized Object of Follow-Up Status	This JSON Object refers to the status of the follow-up.
followupMethod	Identifiable Localized Object of Follow-up method	This JSON Object refers to the method by which the follow-up was answered.
metadata	String	This metadata field is a string field. As a developer, you can add anything that you find useful to it and retrieve it.
followupReason	Localized Object	This field represents the reason why the follow-up is happening. This field is defined through Empego’s Questionnaire.
customFollowupReason	String	This field represents the reason why the follow-up is happening. This is a custom field that can be filled by the staff when they create a follow-up.
followupSummary	Localized Object	This is the formatted and localized summary of the follow-up so it can be provided to the integrating system. Everything that Empego can localize will be, but it is possible that some information is not localized because of the language in which the staff wrote it. *Only present when followupStatus is DONE.
billableDinList	Array of String	This field represents the codes of billable din. *Only present when followupStatus is DONE.
smsDeliveryStatus	String	This field represents the status of the sms delivery
emailDeliveryStatus	String	This field represents the status of the email delivery
attachments	Array of String	This field contains all the unique identifiers of the pictures that the patient has uploaded while answering the questions. *Only present when followupStatus is DONE.
followUpReminderList	Array of Follow-up reminder data	This field represents the dates when follow-up reminders were sent to the patient. *Only present when followupStatus is CANCELLED.

Follow-Up Status

Status Flow

ID	Localized Value FR	Localized Value EN	Description
ARCHIVED	Archivé	Archived	Follow-up is in the `Archive` tab of the dashboard; It has either been archived by a user manually or its status has changed automatically after being `Done` for more than 2 days.
CANCELLED	Annulé	Archived	Follow-up is in the `Archive` tab of the dashboard. It has been manually cancelled by a user before the questionnaire was either sent or completed.
DONE	Terminé	Done	Follow-up is in the `Done` column of the dashboard’s main tab. It has either been dragged and dropped in the `Done` column or a user clicked on `Close and Finish`on an `On-going` follow-up.
IN_PROGRESS	En cours	In progress	Follow-up is in the `In progress`column of the dashboard’s main tab. It has either been dragged and dropped in the `On-going` column or a user clicked on `Begin Analysis` on a `To be analyzed` follow-up.
PLANNED	En attente d’envoi	Waiting to be sent	Follow-up is in `Planned` tab of the dashboard. It has been created, but the questionnaire was not sent yet.
UNANSWERED	Non répondu	Unanswered	Follow-up is in the `Unanswered` tab of the dashboard. It has been sent (or is ready to be answered if the method is `Assisted`), but the questionnaire has not been completed yet.
TO_BE_ANALYZED	À analyser	To be analyzed	Follow-up is in the `To be analyzed` column of the dashboard’s main tab. The completed questionnaire has been submitted by either the patient or an employee.

flowchart TD
    A([Follow-up creation])
    H[CANCELLED]

    subgraph Planned_Section[Planned section]
        B[PLANNED]
    end

    subgraph Unanswered_Section[Unanswered section]
        C[UNANSWERED]
    end

    subgraph Dashboard_Section[Main dashboard section]
        D[TO_BE_ANALYZED]
        E[IN_PROGRESS]
        F[DONE]
    end

    subgraph Archive_Section[Archive section]
        G[ARCHIVED]
    end

    %% Transitions
    A --> B
    B -->|Planned date arrives| C
    B -->|User wants to cancel the consultation| H
    C -->|Follow-up submission| D
    C -->|User wants to cancel the consultation| H
    D -->|User is ready to analyse data collection| E
    D -->|Drag and drop status change within the dashboard tab| E
    E -->|User has completed the follow-up| F
    F -->|User manually archives the follow-up| G
    F -->|Follow-up was moved to Archived after 48h| G

Follow-Up Method

ID	Localized Value FR	Localized Value EN	Description
NOT_ASSISTED	Suivi envoyé au patient	Patient was not assisted	The pharmacy employee planned the follow-up to be sent to the patient (by SMS, Email, or both) on the selected day.
ASSISTED	Suivi assisté avec un employé	Patient was assisted	The pharmacy employee planned the follow-up, but it will not be sent to the patient. Instead, the pharmacy employee will be notified to call the patient and fill out the questionnaire with them on the selected day.