GDX Analytics Events

Introduction

This page documents the different GDX Analytics events issued by Health Gateway and Health Gateway Admin.

Event Structure

All events include an action and text. Additional properties are included depending on the event.

{
    action: "",
    text: "",
    actor?: "",
    dataset?: "",
    destination?: "",
    format?: "",
    origin?: "",
    rating?: "",
    type?: "",
    url?: "",
}

Health Gateway Event Structure

Action	Text	Additional Properties
"Download"	"Document"	dataset | typeoptional | format | actor
"Download"	"Document"	type | format | actor
"Download"	"Export"	dataset | format | actor
"Load"	"Data"	dataset
"Submit"	"App Rating"	rating
"Submit"	"Request"	type
"View"	"Page"	url
"Visit"	"External Link"	destination | origin
"Visit"	"Internal Link"	destination | origin

Health Gateway Admin Event Structure

Action	Text	Additional Properties
"Mail"	"Document"	type
"Print"	"Document"	type

Full Event List

Action	Text	Additional Properties
"Visit"	"Page"	url: "/covid19"
"Download"	"Document"	type: "COVID-19 Proof of Vaccination", format: "Image", actor: "User"
"Download"	"Document"	type: "COVID-19 Proof of Vaccination", format: "PDF", actor: "User"
"Download"	"Document"	type: "COVID-19 Proof of Vaccination", format: "PDF", actor: "Guardian"
"Download"	"Document"	dataset: "Lab Results", format: "PDF", actor: "Guardian"
"Download"	"Document"	dataset: "Clinical Documents", format: "PDF", actor: "Guardian"
"Visit"	"Internal Link"	destination: "Timeline", origin: "Dependents"
"Visit"	"Internal Link"	destination: "Immunization Recommendations Dialog", origin: "Dependents"
"Download"	"Document"	type: "COVID-19 Proof of Vaccination", format: "PDF", actor: "Guardian"
"Download"	"Document"	type: "COVID-19 Proof of Vaccination", format: "PDF", actor: "User"
"Visit"	"External Link"	destination: "Health Gateway Beta", origin: "Home"
"Visit"	"Internal Link"	destination: "Timeline", origin: "Home"
"Visit"	"Internal Link"	destination: "BC Vaccine Card", origin: "Home"
"Visit"	"Internal Link"	destination: "Organ Donor Registration", origin: "Home"
"Visit"	"Internal Link"	destination: "Immunization Recommendations Dialog", origin: "Home"
"Visit"	"External Link"	destination: "Primary Care", origin: "Home"
"Visit"	"Internal Link"	destination: "<dataset> Timeline", origin: "Home"
"Download"	"Document"	type: "Organ Donor Registration", format: "PDF", actor: "User"
"Download"	"Document"	dataset: "BC Cancer", type: "Result", format: "PDF", actor: "User"
"Download"	"Document"	dataset: "BC Cancer", type: "Recall", format: "PDF", actor: "User"
"Download"	"Document"	dataset: "Clinical Documents", format: "PDF", actor: "User"
"Download"	"Document"	dataset: "COVID‑19 Tests", format: "PDF", actor: "User"
"Download"	"Document"	dataset: "Imaging Reports", format: "PDF", actor: "User"
"Download"	"Document"	dataset: "Lab Results", format: "PDF", actor: "User"
"Submit"	"Request"	type: "Public COVID-19 Proof of Vaccination"
"Download"	"Document"	type: "Public COVID-19 Proof of Vaccination", format: "Image", actor: "User"
"Download"	"Document"	type: "Public COVID-19 Proof of Vaccination", format: "PDF", actor: "User"
"Submit"	"App Rating"	rating: "skip" | "1" | "2" | "3" | "4" | "5"
"Visit"	"External Link"	destination: "Public Health Immunization Schedule", origin: "Exports"
"Visit"	"External Link"	destination: "BC Gov Immunizations", origin: "Exports"
"Visit"	"External Link"	destination: "Book a Vaccine", origin: "Immunization Recommendations Dialog"
"Download"	"Export"	dataset: "<dataset>", format: "CSV" | "PDF" | "XLSX", actor: "User"
"Download"	"Export"	dataset: "<dataset>", format: "CSV" | "PDF" | "XLSX", actor: "Guardian"
"Load"	"Data"	dataset: "<dataset>"
"Mail"	"Document"	type: "COVID-19 Proof of Vaccination"
"Print"	"Document"	type: "COVID-19 Proof of Vaccination"

Usage of <dataset> in the table above indicates the row represents multiple events with values corresponding to each of the following datasets:

Dataset Values
"BC Cancer"
"Clinical Documents"
"COVID-19 Tests"
"Health Visits"
"Hospital Visits"
"Imaging Reports"
"Immunizations"
"Lab Results"
"Notes"
"Medications"
"Special Authority Requests"