Consultation

Event wrapper values

• Each time a consultation is created

Field	Value(s)
eventType	consultation
operation	create

• Each time a consultation status changed.

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"
    },
    "consultationPdfKey": "UUID",
    "billableDinList": ["STRING"],
    "smsDeliveryStatus": "STRING",
    "emailDeliveryStatus": "STRING",
    "firstName": "STRING",
    "lastName": "STRING",
    "assignations": ["STRING"]
  }
}

Field	Type	Description
consultationKey	UUID	This is the consultation's unique identifier.
patientKey	UUID / null	This is Empego's patient unique identifier. Only set if the consultation have been created using a pre-existing patient in Empego.
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.
consultationCreatedAt	UTC Timestamp	Timestamp for when the consultation was created. The format is YYYY-MM-DD hh:mm:ss.
consultationAnsweredAt	UTC Timestamp / null	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 / null	Optional metadata associated with the request for tracking and correlation purposes. Note: If a follow-up is planned from the current consultation the metadata will be copied to the follow-up.
consultationReason	Localized Object / Empty object / null	This field represents the reason why the consultation is happening. This field is defined through Empego's Questionnaire.
customConsultationReason	String / null	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 / null	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.
consultationPdfKey	UUID / null	This is the unique identifier of the PDF attachment generated for this consultation. Pass this key to Get attachment to obtain a download URL. *Only present if consultationStatus is DONE.
billableDinList	Array of String / Empty array / null	This field represents the codes of billable din. *Only present if consultationStatus 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 download URL. *Only present if consultationStatus is DONE.
firstName	String	The Firstname of the patient.
lastName	String	The Lastname of the patient.
assignations	Array of String / Empty array	A list of unique identifiers for the users (employees) currently assigned to this consultation.

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": "userId:123,workstationId:456",
      "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"
      },
      "consultationPdfKey": "7fa3c201-XXXX-4b12-a8e1-9d3f02c1b445",
      "billableDinList": ["00969974", "00969975"],
      "smsDeliveryStatus": "SENT_SUCCESSFULLY",
      "emailDeliveryStatus": "NOT_SENT",
      "attachments": ["3dd1b34f-XXXX-9359-6f903fe8d1d5.png"],
      "firstName": "John",
      "lastName": "Doe",
      "assignations": ["ae0461f6-e2ab-XXXX-96915f8df40ef", "ae0461f6-e2ab-XXXX-96915f8df40r"]
    }
  }
}

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.
APPOINTMENT	Sur rendez-vous	By Appointment	The patient filled the questionnaire in preparation for an appointment, they either generated a consultation by themselves using a public link (i.e. provided to them when booking their appointment) or a pharmacy employee generated the consultation when planning the appointment.