Follow-Up

Event wrapper values

Each time a follow-up 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",
    "baseFollowUpKey": "STRING",
    "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"
    },
    "followupPdfKey": "UUID",
    "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"
      }
    ],
    "firstName": "STRING",
    "lastName": "STRING",
    "assignations": ["STRING"]
  }
}

Field	Type	Description
followupKey	UUID	This is the follow-up unique identifier.
patientKey	UUID	This is Empego's patient unique identifier.
externalPatientKeys	JSON Array / Empty array	This array 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 / null	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 / null	Timestamp for when the follow-up was finished. The format is `yyyy-MM-dd HH:mm:ss.SSS`.
recurring	boolean	Specifies that the follow-up is recurring.
baseFollowUpKey	String / null	This is the base follow-up unique identifier. All recurring follow-ups share the same base follow-up identifier. *Only present if recurring is true.
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 / null	Optional metadata associated with the request for tracking and correlation purposes. Note: This metadata will be copied in linked recurring follow-ups and when planning a follow-up from a consultation where it contained metadata.
followupReason	Localized Object / Empty object / null	This field represents the reason why the follow-up is happening. This field is defined through Empego's Questionnaire.
customFollowupReason	String / null	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 / Empty object / null	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 if followupStatus is DONE.
followupPdfKey	UUID / null	This is the unique identifier of the PDF attachment generated for this follow-up. Pass this key to Get attachment to obtain a download URL. *Only present if followupStatus is DONE.
billableDinList	Array of String / Empty array / null	This field represents the codes of billable din. *Only present if 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 / Empty array / null	This field contains all the unique identifiers of the pictures that the patient has uploaded while answering the questions. Pass each key to Get attachment to obtain a download URL. *Only present if followupStatus is DONE.
firstName	String	The Firstname of the patient.
lastName	String	The Lastname of the patient.
followUpReminderList	Array of Follow-up reminder data / null / Empty array	This field represents the dates when follow-up reminders were sent to the patient. *Only present if followupStatus is CANCELLED.
assignations	Array of String / Empty array	A list of unique identifiers for the users (employees) currently assigned to this follow-up.

Example

{
  "followup": {
    "followupKey": "2db85339-9d25-423e-XXXX-3f53bd4283f",
    "patientKey": "2db85339-9d25-423e-XXXX-3f53bd4283f",
    "externalPatientKeys": [
      {
        "subSystem": "Drugstore Inc.",
        "key": "ae0461f6-e2ab-XXXX-96915f8df40d"
      }
    ],
    "tenantKey": "2db85339-9d25-423e-XXXX-3f53bd4283f",
    "followupAnsweredAt": "2024-03-13 23:37:54.000",
    "followupScheduledAt": "2024-03-12 23:37:54.000",
    "followupFinishedAt": "2024-03-14 23:37:54.000",
    "recurring": "false",
    "baseFollowUpKey": "2db85339-9d25-423e-XXXX-3f53bd4283f",
    "followupStatus": {
      "en": "Done",
      "id": "DONE",
      "fr": "Terminé"
    },
    "followupMethod": {
      "id": "NOT_ASSISTED",
      "en": "Patient was not assisted",
      "fr": "Suivi envoyé au patient"
    },
    "metadata": "userId:123,workstationId:456",
    "followupReason": {
      "en": "Digestive problem",
      "fr": "Problème digestif"
    },
    "customFollowupReason": null,
    "followupSummary": {
      "en": "Follow-up date: 25 Mar 2024, 13:17\nFollow-up reason: Digestive problem\nPersonal information: \n\tMedication: Yes\nData collection: \n\tPatient history: \n\t\tChronology of digestive problems: Less than 2 weeks\n\t\t🚩Symptom progression: Worsening\n\t\tTrouble eating: N/A\n\t\tChronic digestive disease: N/A\n\t\tPrevious OTC trial: N/A\n\t\tAffected toenails: N/A\n\tSymptoms: \n\t\tIntestinal gas: Yes\n\t\tHeartburn: Yes\n\t\tNausea and/or vomiting: Only nausea\n\t\tConstipation: No\n\t\tDiarrhea: N/A\n\t\tBlood or mucus in stools: N/A\n\t\tAbdominal pain or cramps: N/A\n\t\tUnexplained weight loss: N/A\n\t\tFever: N/A\nAdditional information: \nN/A\nPharmacist comments: \nN/A",
      "fr": "Date du suivi : 25 Mar 2024, 13:17\nRaison du suivi : Problème digestif\nRenseignements personnels : \n\tMédication : Oui\nCollecte de données : \n\tHistoire patient : \n\t\tChronologie problèmes digestifs: Moins de 2 semaines\n\t\t🚩Évolution symptômes: Aggravation\n\t\tDifficultés à s'alimenter: N/A\n\t\tMaladie digestive de longue date: N/A\n\t\tEssai antérieur MVL: N/A\n\t\tAtteinte des ongles des pieds: N/A\n\tSymptômes : \n\t\tGaz intestinaux: Oui\n\t\tBrûlures d'estomac: Oui\n\t\tNausées et/ou vomissements: Nausées seulement\n\t\tConstipation: Non\n\t\tDiarrhée: N/A\n\t\tSang ou mucus dans les selles: N/A\n\t\tDouleur abdominale : N/A\n\t\tPerte de poids inexpliquée: N/A\n\t\tFièvre: N/A\nInformation additionnelle : \nN/A\nCommentaires pharmacien : \nN/A"
    },
    "followupPdfKey": "7fa3c201-XXXX-4b12-a8e1-9d3f02c1b446",
    "billableDinList": ["00969974", "00969975"],
    "smsDeliveryStatus": "SENT_SUCCESSFULLY",
    "emailDeliveryStatus": "SENT_SUCCESSFULLY",
    "attachments": ["3dd1b34f-XXXX-9359-6f903fe8d1d5.png"],
    "followUpReminderList": [
      {
        "followUpReminderSentAt": "2024-05-05 23:04:05.888"
      },
      {
        "followUpReminderSentAt": "2024-05-06 23:04:05.888"
      }
    ],
    "firstName": "Jane",
    "lastName": "Doe",
    "assignations": ["ae0461f6-e2ab-XXXX-96915f8df40ef", "ae0461f6-e2ab-XXXX-96915f8df40r"]
  }
}

Follow-Up Status

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 or its status has changed automatically to `EXPIRED` after being left `UNANSWERED` for more than 30 days.
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.

Status Flow

Follow-up status flow diagram

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.

Event wrapper values​

Data Schema​

Example​

Follow-Up Status​

Follow-Up-Method​

Event wrapper values

Data Schema

Example

Follow-Up Status

Follow-Up-Method