[BACK-3970] Add spec for configurable TIDE report categories. #170
Conversation
|
| properties: | ||
| name: | ||
| description: Name of the category. | ||
| type: string |
There was a problem hiding this comment.
I'd suggest a maxlength setting, even if it's 1024, just something to prevent... issues. :P
| type: string | ||
| enum: ['>', '>=', '<', '<=', '='] | ||
| value: | ||
| description: Value to compare summaryField against. |
There was a problem hiding this comment.
No type specification for the value? Can you specify something like:
$ref: ./tideSummaryField.v1.yaml
| name: | ||
| description: Name of the category. | ||
| type: string | ||
| comparison: |
There was a problem hiding this comment.
I'd suggest "filter", or "membership" or "inclusion-criteria" might be better names. Sure, this is a comparison, but for what purpose is the comparison being made?
| - summaryField | ||
| - direction | ||
| priority: | ||
| description: Priority of category to use when iterating against a list of categories when generating a TIDE report with a lower value having higher priority. This is used to because of a TIDE report patient limit so higher priority categories will be queried first. |
There was a problem hiding this comment.
| description: Priority of category to use when iterating against a list of categories when generating a TIDE report with a lower value having higher priority. This is used to because of a TIDE report patient limit so higher priority categories will be queried first. | |
| description: Categories are evaluated in priority order, stopping after the patient limit is reached. Smaller values have HIGHER priority. |
I feel like the above is a little clearer. In any event, This is used to because of a TIDE should be edited.
| type: object | ||
| title: tidethresholds.v1 | ||
| description: 'Represents the boundary values for a value to be considered low / high.' | ||
| properties: |
There was a problem hiding this comment.
Not sure if you want to include it here or not (maybe it's more detail than needed here), but the thresholds typically include a boolean flag for "inclusive", and their value is usually their "lowerBound". The idea being if you have these thresholds:
- name: low
lowerBound: 10
inclusive: false
- name: in range
lowerBound: 40
inclusive: true
- name: high
lowerBound: 83
inclusive: false
Then a value of 83 is in range, a value of 40 is in range but 39.999 is low, and 83.00001 is high. The ADA standard thresholds make use of such "nudge towards in-range" methods in their definitions.
lostlevels
force-pushed
the
jp-back-3970-tide-categories
branch
from
9e016c5 to
bff2ba2
Compare
No description provided.