Skip to content

Commit 0a9f05a

Browse files
committed
documentation update for aggregations proposal
... more information for `filters` use in aggregation concepts; thanks @costero-e for pointing this out
1 parent 5b588f3 commit 0a9f05a

1 file changed

Lines changed: 9 additions & 2 deletions

File tree

docs/aggregations.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -190,8 +190,15 @@ are simply derived from those.
190190

191191
Aggregation concepts can have additional modifiers:
192192

193-
* `filters` - to limit the aggregation to a subset of the data, e.g. to a selection of disease codes
194-
- the usual filter definitions apply; _i.e._ if an ontology term is used as filter value the count will include all records with this term or any of its child terms (unless the filter's `includeDescendantTerms` flag is set to `False`)
193+
* `filters` - to limit the aggregations to subsets of the data, e.g. to a selection
194+
of disease codes
195+
- If `filters` are indicated for an aggregation concept, only aggregations
196+
for the concept's property fulfilling the individual filters will be reported
197+
- Without `filters` all values for the property will be reported (with potential limits
198+
imposed by the beacon).
199+
- The usual filter definitions apply; _i.e._ if an ontology term is used as
200+
filter value the count will include all records with this term or any of
201+
its child terms (unless an `includeDescendantTerms` flag is set to `False`)
195202
* `splits` - to partition continuous data such as age values, followup times or other numeric measurements into countable bins
196203
- Note: `splits` are upper & exclusive boundaries of bins, following established practices (_cf._ `$split` use in [MongoDB aggregation pipelines](https://www.mongodb.com/docs/manual/reference/operator/aggregation/split/))
197204

0 commit comments

Comments
 (0)