Skip to content

Glossary

Definitions for the core MedFlow terms used across these docs and the API.

TermMeans
MedFlowThe clinical automation product. You configure Workflows in it.
WorkflowThe unit you configure: a Trigger, a Diagram, and Metrics together.
TriggerHow work starts. There are three types: web, search, and event.
DiagramA care pathway, either a blueprint or an instance.
BlueprintThe pathway template you author in the diagram editor.
InstanceA copy of a blueprint, made to be run (sourceId points at the blueprint).
Care pathway / PathwayThe clinical name for a Diagram.
idA diagram’s own id, whether it is a blueprint or an instance.
sourceIdThe blueprint id a thing was copied from.
runIdOne care pathway run created by a trigger. It is also the id of the run’s pathway instance.
Workflow templateA complete, ready-made Workflow (Trigger, Diagram, and Metrics), such as Cognitive Testing.
RunOne active care pathway started by a trigger (runId).
Web triggerA trigger you fire directly by POSTing a payload to its own URL, POST /v1/triggers/:triggerId, with an API key.
Search triggerA trigger that runs a query and starts a pathway for each match, optionally on a schedule.
Event triggerA trigger that starts a pathway when MedFlow raises an event, such as a new patient or a lab result. MedFlow raises the event from data it receives or a change it detects, and no external system fires it.
WebhookAn inbound URL an external system POSTs data to. MedFlow ingests the data and may raise an event from it. A webhook does not fire a trigger itself.
Inbound ingestAn external system POSTs data (JSON or FHIR) to a webhook URL for Find. MedFlow may also raise events from it.
Outbound web requestAn automated action that calls an external HTTP endpoint from a pathway node.
EventSomething MedFlow can raise that an event trigger starts a run from, such as New Patient, Lab Result, or Webhook Received.
Automated actionAn executable system step on a node (Connections type automation).
automationStatusThe execution state of a run.
NodeA typed step on a diagram, such as a task, decision, or wait (nodeId). A system step runs an automated action.
SwimlaneThe owner lane a node sits in, such as clinic staff, an EHR, a lab, or a patient channel.
ResourceA clinical entity in the graph that Find searches, such as a patient, practitioner, encounter, or observation. Resources are normalized to FHIR. Distinct from a Node, which is a step on a diagram.
MetricsThe outcomes you measure.
Find · Automate · ValidateThe loop the engine runs under every Workflow.
ConnectionThe umbrella for events, actions, and data sources.
Data sourceA sync or connector that brings data into MedFlow, by pull or push.
GraphFlowThe visual workflow engine that MedFlow runs on.
IDMeans
runIdCare pathway run
idDiagram id (blueprint or instance)
sourceIdBlueprint id
triggerIdHow work starts
queryIdFind query
nodeIdHuman or system step on a care pathway
automationIdAutomated action on a node
  1. You configure a Workflow (Trigger + Diagram + Metrics).
  2. The Trigger (triggerId) is how work starts. It points at a blueprint (sourceId) and creates Runs (runId). See Triggers, Diagrams, and Runs.
  3. The Diagram is the care pathway, drawn with swimlanes and nodes (nodeId). Nodes are human or system steps. System steps run automated actions (automationId) from the Connections catalog.
  4. Metrics are the outcomes you measure. Find · Automate · Validate is how the engine works under that Workflow.

See Workflows, Diagram nodes, Triggers, and the Connections catalog.