ReferenceFor engineers

Data schema

How care flow data is structured in the repository, and the definition-versus-instance distinction that every query depends on.

Awell's data repository separates the templates designed in Studio from the patient-specific instances created from them. Which of the two a query targets decides what it counts.

Definitions are templates, instances belong to patients

Care flow definition vs care flow

A care flow definition is the template designed in Studio. It describes the structure and components of a care plan and isn't tied to any patient.

A care flow is a patient-specific instance derived from that definition.

So for a definition named "post-operative follow-up", every enrolled patient has their own care flow derived from it. Query definitions to ask about the design; query care flows to ask about patients.

Data point definition vs data point

The same distinction one level down. A data point definition is the component designed in Studio, for example "patient weight". A data point is one patient's value, for example 80 kg.

Getting these the wrong way around produces queries that look right and count the wrong thing: definitions count how many fields exist, data points count how many answers were given.

Data point keys come from the identifier set in Studio

Instead of randomly generated IDs, a data point definition carries a human-readable identifier set in Studio. In the data repository that identifier is combined with its source to form a key.

So encoding questions pays off in analysis as well as in care flow logic: the key set at design time is the key a query runs against later.

Release and version are not the same thing

A care flow definition has both, so check which one a query needs: filtering on the wrong one changes the denominator without any error.

BigQuery holds the authoritative column list

Tables cover care flow definitions, care flows, data points, activities and related entities. Explore them in BigQuery Studio, where the current column lists are authoritative.

Columns change, so this page describes the model rather than reproducing every column. If a query depends on an exact column, check it in BigQuery.

Next steps

Next: Monthly active patients — the definition Awell bills on.

On this page