Consultation

Event wrapper values

  • Each time a consultation is created
Field Value(s)
eventType consultation
operation create
Field Value(s)
eventType consultation
operation update

Data Schema

{
  "consultation": {
    "consultationKey": "UUID",
    "patientKey": "UUID",
    "externalPatientKeys": [
      {
        "subSystem": "STRING",
        "key": "STRING"
      }
    ],
    "tenantKey": "UUID",
    "consultationCreatedAt": "UTC_TIMESTAMP",
    "consultationAnsweredAt": "UTC_TIMESTAMP",
    "consultationFinishedAt": "UTC_TIMESTAMP",
    "consultationStatus": {
      "id": "STRING",
      "en": "ENGLISH_STRING",
      "fr": "FRENCH_STRING"
    },
    "consultationLocation": {
      "id": "STRING",
      "en": "ENGLISH_STRING",
      "fr": "FRENCH_STRING"
    },
    "metadata": "STRING",
    "consultationReason": {
      "en": "ENGLISH_STRING",
      "fr": "FRENCH_STRING"
    },
    "customConsultationReason": "STRING",
    "consultationSummary": {
      "en": "ENGLISH_STRING",
      "fr": "FRENCH_STRING"
    },
    "billableDinList": ["STRING"],
    "smsDeliveryStatus": "STRING",
    "emailDeliveryStatus": "STRING"
  }
}
Field Type Description
consultationKey UUID This is the consultation’s unique identifier.
patientKey UUID This is Empego’s patient unique identifier.
externalPatientKeys JSON Object 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.
consultationCreatedAt UTC Timestamp Timestamp for when the consultation was created. The format is YYYY-MM-DD hh:mm:ss.
consultationAnsweredAt UTC Timestamp Timestamp for when the consultation was answered. The format is YYYY-MM-DD hh:mm:ss.
consultationStatus Localized object of Consultation Status This JSON Object refers to the status of a consultation. See Consultation Status below to see the status definition.
consultationLocation Localized object of Consultation Location This JSON Object refers to the location in which a consultation can happen. See the Consultation Location below to see the status definition.
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.
consultationReason Localized Object This field represents the reason why the consultation is happening. This field is defined through Empego’s Questionnaire.
customConsultationReason String This field represents the reason why the consultation is happening. This is a custom field that can be filled by the staff when they create a consultation.
consultationSummary Localized Object This is the formatted and localized summary of the consultation 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 consultationStatus is DONE.
billableDinList Array of String This field represents the codes of billable din. *Only present if consultationStatusis 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 if consultationStatus is DONE.
firstName String The Firstname of the patient. *Only present if patientKey is null.
lastName String The Lastname of the patient. *Only present if patientKey is null.

Example

{
  "id": "2db85339-9d25-423e-XXXX-3f53bd4283f",
  "createdAt": "2024-03-25 17:17:33.459",
  "eventType": "consultation",
  "operation": "update",
  "tenantKey": "11f81012-9519-XXXX-0244cd4cfa84",
  "data": {
    "consultation": {
      "consultationKey": "3dd1b34f-XXXX-9359-6f903fe8d1d5",
      "patientKey": "563ea535-ac75-XXXX-1e48706afeff",
      "tenantKey": "11f81012-9519-XXXX-0244cd4cfa84",
      "consultationCreatedAt": "2024-03-13 23:37:54.000",
      "consultationAnsweredAt": "2024-03-25 17:17:33.098",
      "consultationFinishedAt": null,
      "consultationStatus": {
        "en": "Done",
        "id": "DONE",
        "fr": "Terminé"
      },
      "consultationLocation": {
        "en": "Onsite",
        "id": "ONSITE",
        "fr": "Sur place"
      },
      "metadata": null,
      "consultationReason": {
        "en": "Digestive problem",
        "fr": "Problème digestif"
      },
      "customConsultationReason": null,
      "externalPatientKeys": [
        {
          "subSystem": "Drugstore Inc.",
          "key": "ae0461f6-e2ab-XXXX-96915f8df40d"
        }
      ],
      "consultationSummary": {
        "en": "Consultation date: 25 Mar 2024, 13:17\nConsultation 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 de la consultation : 25 Mar 2024, 13:17\nRaison de la consultation : Problème digestif\nRenseignements personnelles : \n\tMédication : Oui\nCollecte de données : \n\tHistoire patient : \n\t\tChronologie problème 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"
      },
      "billableDinList": ["STRING"],
      "smsDeliveryStatus": "STRING",
      "emailDeliveryStatus": "STRING",
      "attachments": ["3dd1b34f-XXXX-9359-6f903fe8d1d5.png"],
      "firstName": "STRING",
      "lastName": "STRING"
    }
  }
}

Consultation Status

ID Localized Value FR Localized Value EN Description
ARCHIVED Archivé Archived Consultation 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 by midnight.
CANCELLED Annulé Cancelled Consultation is in the Archive tab of the dashboard. A user manually cancelled it before the questionnaire was completed or its status has changed automatically to EXPIRED after being left UNANSWERED for more than 14 days.
DONE Terminé Done Consultation is in the Done column of the dashboard’s main tab. It has either been dragged and dropped in the Done or a user clicked on Close and Finish on an On-going consultation.
IN_PROGRESS En cours In progress Consultation is in the In progress column of the dashboard’s main tab. It has either been dragged and dropped in the In progress column or a user clicked on Begin Analysis on a To be analyzedconsultation.
POSTPONED Reporté Postponed Consultation is in the Postponed tab of the dashboard. A user clicks on Postpone on a Waiting or Ongoing consultation.
UNANSWERED Non répondu Unanswered Consultation is in the Unanswered tab of the dashboard. It has been created, but the questionnaire was not submitted yet.
TO_BE_ANALYZED À analyser To be analyzed Consultation 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.
EXPIRED Expiré Expired Consultation is in the Archive column of the dashboard’s main tab. If a consultation does not receive a response within a period of 14 days, it will be moved to the Expiredstatus.

Status flow

Consultation status flow diagram

 

Consultation Location

ID Localized Value FR Localized Value EN Description
CALLBACKPHONE Au téléphone On the phone The patient is not in the pharmacy but has contacted the pharmacy for a consultation (Generated by a pharmacy employee, the patient is out of the pharmacy)
INTERNET Internet Internet The patient has generated a new consultation themselves on an internet link (Generated by the patient, the patient is out of the pharmacy)
ONSITE Sur place Onsite The patient is at the pharmacy, they either generated a consultation by themselves using an in-pharmacy link or a pharmacy employee generated the consultation.