Glossary
Definitions for the core MedFlow terms used across these docs and the API.
| Term | Means |
|---|---|
| MedFlow | The clinical automation product. You configure Workflows in it. |
| Workflow | The unit you configure: a Trigger, a Diagram, and Metrics together. |
| Trigger | How work starts. There are three types: web, search, and event. |
| Diagram | A care pathway, either a blueprint or an instance. |
| Blueprint | The pathway template you author in the diagram editor. |
| Instance | A copy of a blueprint, made to be run (sourceId points at the blueprint). |
| Care pathway / Pathway | The clinical name for a Diagram. |
id | A diagram’s own id, whether it is a blueprint or an instance. |
sourceId | The blueprint id a thing was copied from. |
runId | One care pathway run created by a trigger. It is also the id of the run’s pathway instance. |
| Workflow template | A complete, ready-made Workflow (Trigger, Diagram, and Metrics), such as Cognitive Testing. |
| Run | One active care pathway started by a trigger (runId). |
| Web trigger | A trigger you fire directly by POSTing a payload to its own URL, POST /v1/triggers/:triggerId, with an API key. |
| Search trigger | A trigger that runs a query and starts a pathway for each match, optionally on a schedule. |
| Event trigger | A 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. |
| Webhook | An 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 ingest | An external system POSTs data (JSON or FHIR) to a webhook URL for Find. MedFlow may also raise events from it. |
| Outbound web request | An automated action that calls an external HTTP endpoint from a pathway node. |
| Event | Something MedFlow can raise that an event trigger starts a run from, such as New Patient, Lab Result, or Webhook Received. |
| Automated action | An executable system step on a node (Connections type automation). |
automationStatus | The execution state of a run. |
| Node | A typed step on a diagram, such as a task, decision, or wait (nodeId). A system step runs an automated action. |
| Swimlane | The owner lane a node sits in, such as clinic staff, an EHR, a lab, or a patient channel. |
| Resource | A 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. |
| Metrics | The outcomes you measure. |
| Find · Automate · Validate | The loop the engine runs under every Workflow. |
| Connection | The umbrella for events, actions, and data sources. |
| Data source | A sync or connector that brings data into MedFlow, by pull or push. |
| GraphFlow | The visual workflow engine that MedFlow runs on. |
Public IDs
Section titled “Public IDs”| ID | Means |
|---|---|
runId | Care pathway run |
id | Diagram id (blueprint or instance) |
sourceId | Blueprint id |
triggerId | How work starts |
queryId | Find query |
nodeId | Human or system step on a care pathway |
automationId | Automated action on a node |
How they nest
Section titled “How they nest”- You configure a Workflow (Trigger + Diagram + Metrics).
- The Trigger (
triggerId) is how work starts. It points at a blueprint (sourceId) and creates Runs (runId). See Triggers, Diagrams, and Runs. - 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. - 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.