Skip to main content

Data Export - Decision Support System

What this export contains​

Decision support is spread across several linked exports rather than a single file. Together they describe the clinical decision support rules you have configured and what those rules did for each patient. The setup exports (Entity Decision Algorithm, Workflow and Workflow Action) define the rules. The triggered exports (Triggered Decision Algorithm, Triggered Workflow, Triggered Workflow Action, Triggered Workflow Action Log and Provider Notification) record what fired for each patient and what was done about it.

Example questions these exports can answer​

  • See which decision support rules (algorithms) are configured and active
  • Count how often a rule, for example a self-harm alert, triggered over a period
  • See what actions providers were prompted to take and which they completed
  • Audit the provider notifications sent in response to triggered alerts
  • Measure responsiveness to high-priority clinical alerts

How the Decision Support System fits together​

There are two sets of linked tables that support Mirah’s decision support functionality.

The first is the setup instructions:

  • Entity Decision Algorithm supplies the configuration for what decision support is going to trigger, including what dates and the population of patients it applies to, and other settings.
  • Workflow is a specific action that an algorithm can trigger. For example, ‘if the patient endorses a self harm item…”.
  • Workflow Action is a specific action, either taken by the system or instructing the provider. For example:
    • “Add the patient to a given treatment track” (system)
    • “Complete a safety planning exercise for the patient” (instruction to provider)

These combine as follows:

  • Configure an algorithm to run on all patients currently in outpatient treatment… (Entity Decision Algorithm).
  • Which triggers a workflow whenever a patient endorses a self harm item…(Workflow).
  • That prompts them to do a safety plan (Workflow Action).

Whenever the triggering event occurs, an additional set of tables include information about what steps have happened for that particular patient:

  • Triggered Decision Algorithm links to Entity Decision Algorithm and a particular Episode of Care to show that this episode of care has been triggered by the algorithm.
  • Triggered Workflow shows that a particular workflow has been triggered for this patient, and is linked to the Triggered Decision Algorithm.
  • Triggered Workflow Action shows the actions that are available for this patient.
  • Triggered Workflow Action Log shows which actions were actually taken by the system or by a provider.
  • Provider Notification shows the inbox notifications and emails sent to a provider.

The order of columns is subject to change. When parsing files, please ensure to use headers rather than positional parsing to ensure you are reading the data correctly.

Entity Decision Algorithm​

The Entity Decision Algorithm represents at a top level a Decision Support algorithm that is in use.

ColumnNameFormatNullableDescriptionNotes
instituteidInstitute Ididentifierfalse
instituteShortcodeInstitute ShortcodeStringfalse
idIDuuidfalseThe Mirah internal identifier of the algorithm
nameNamestringfalseThe visible name of the algorithm
notesNotesstringtrueAdditional notes displayed as context for the algorithm
paramsParamsjsontrueAdditional configuration paramsThis is Mirah internal and is not well documented for external use but is provided as context
sendNotificationsSend Notifications?booleanfalseWhether notifications will be sent for this algorithmProviders will receive alerts in their inbox either way but this governs if emails will be sent
startDateStart DatedatetimetrueThe first date for which this algorithm will process data
statusStatusActive | pausedhiddendisabledfalseIs this algorithm activePaused = algorithm will not trigger but existing alerts will be visibleHidden = algorithm triggers but alerts will not be generatedDisabled = algorithm will not be triggered and alerts are hidden
workflowNoteWorkflow NotestringfalseAdditional information surfaced to the provider when the workflow triggersThis can be used to customize instructions etc

Workflow​

A set of potential decisions and actions that can be triggered by an event. Generally only one workflow is active per algorithm per episode of care at a time. The highest priority algorithm will take precedence.

ColumnNameFormatNullableDescriptionNotes
instituteidInstitute Ididentifierfalse
instituteShortcodeInstitute ShortcodeStringfalse
idIduuidfalseThe Mirah identifier
callToActionCall To ActionstringfalseThe top description of the workflow designed to spur actionE.g. “Patient has reported self harm”
defaultPriorityDefault PriorityintegerfalseThe priority of this workflow
descriptionDescriptionstringtrueAn optional description of this workflow
emailBodyEmail BodystringfalseThe body of the email that is constructed when the workflow triggers
emailSubjectEmail SubjectstringfalseThe subject of the email that is constructed when the workflow triggers
instructionsInstructionsmarkdowntrueThe set of instructions that will be displayed to users when this workflow triggers
notificationModeNotification ModeSend_email | no_emailfalseWhether emails will be sent
titleTitlestringfalseThe name of the workflow
createdAtCreated Atdatetimefalse
updatedAtUpdated AtDatetimefalse

Workflow Action​

An action that can be taken as part of a workflow, either by the system or as a prompt for a provider. For example - ‘add a patient to a treatment track’, or ‘complete safety planning with a patient’.

ColumnNameFormatNullableDescriptionNotes
instituteidInstitute Ididentifierfalse
instituteShortcodeInstitute ShortcodeStringfalse
idIduuidfalseThe Mirah identifier
phasePhaseManual | beforeafterfalseWhen this action occursManual: this action can only be triggered by a user.Before: this action will automatically trigger when the workflow startsAfter: this action will automatically trigger when the workflow completes
reusableReusablebooleanfalseWhether this action can be used multiple times
sideEffectParamsSide EffectsjsontrueThis is an internal column which includes state on how to trigger parameters
textTextstringfalseThe text to display for this action
createdAtCreated Atdatetimefalse
updatedAtUpdated AtDatetimefalse
workflowIdWorkflow IduuidfalseThe workflow this action is associated with

Triggered Decision Algorithm​

This table represents the triggering of an algorithm for a particular patient’s episode of care.

ColumnNameFormatNullableDescriptionNotes
instituteidInstitute Ididentifierfalse
instituteShortcodeInstitute ShortcodeStringfalse
idIduuidfalseThe Mirah identifier
contextContextjsontrueAn internal blob of information containing useful additional context on how the algorithm was triggered
statusStatusActive | completecanceledfalseThe status of this algorithm
triggeredAtTriggered AtdatetimefalseWhen the algorithm was triggered
careEpisodeIdCare Episode IduuidfalseThe episode of care this algorithm has been triggered for
entityDecisionAlgorithmIdEntity Decision Algorithm IduuidfalseThe algorithm triggered

Triggered Workflow​

An active workflow for an episode of care.

ColumnNameFormatNullableDescriptionNotes
instituteidInstitute Ididentifierfalse
instituteShortcodeInstitute ShortcodeStringfalse
idIduuidfalseThe Mirah identifier
activeSinceActive SincedatetimefalseWhen this workflow became active
isCurrentlyTriggeredCurrently TriggeredbooleanfalseIs this workflow currently active
priorityPriorityintegerfalseThe priority of this workflowOnly one workflow can be active for the same algorithm at the same time
reasonsReasonsstringtrueA text based summary of why this workflow was triggeredE.g. “The patient scored a 14 on the PHQ-9 which is above the threshold of 7”
snoozedUntilSnoozed UntildatetimetrueThis item is snoozed until this time
statusStatusActive | snoozedcompletecanceledfalseThe status of this item
triggeredAtTriggered AtdatetimefalseWhen this item was triggered
statusUpdatedByIdStatus Updated By IduuidtrueThe user id who updated the status last
triggeredDecisionAlgorithmIdTriggered Decision Algorithm IduuidfalseThe reference to Triggered Algorithm Decision
workflowIdWorkflow IduuidfalseThe reference to Workflow

Triggered Workflow Action​

An action for a particular Triggered Workflow that may be taken.

ColumnNameFormatNullableDescriptionNotes
instituteidInstitute Ididentifierfalse
instituteShortcodeInstitute ShortcodeStringfalse
idIduuidfalseThe Mirah identifier
statusStatusAvailable | usedfalseThe status of the actionAvailable: this action can be takenUsed: this action has already been taken
createdAtCreated AtDatetimefalse
updatedAtUpdated AtDatetimefalse
triggeredWorkflowIdTriggered Workflow IduuidfalseWhich Triggered Workflow this refers to
workflowActionIdWorkflow Action IduuidfalseWhich Workflow Action this refers to

Triggered Workflow Action Log​

A log of the actions taken for a workflow.

ColumnNameFormatNullableDescriptionNotes
instituteidInstitute Ididentifierfalse
instituteShortcodeInstitute ShortcodeStringfalse
idIduuidfalseThe Mirah identifier
triggeredWorkflowActionIdTriggered Workflow Action IduuidfalseThe Triggered Workflow Action used
userIdUser IduuidfalseThe user taking the action
usedAtUsed AtDatetimefalseWhen the action was taken

Provider Notification​

A notification sent to an individual provider regarding a triggered workflow.

ColumnNameFormatNullableDescriptionNotes
instituteidInstitute Ididentifierfalse
instituteShortcodeInstitute ShortcodeStringfalse
idIduuidfalseThe Mirah identifier
sentAtSent AtdatetimetrueIf a notification was sent, when it was emailed
createdAtCreated Atdatetimefalse
updatedAtUpdated Atdatetimefalse
providerIdProviderIduuidfalseThe provider receiving the notification
triggeredWorkflowIdTriggered Workflow IduuidfalseThe triggered workflow requiring notification