attribute | type | cardinality | unique | required | doc |
---|
cycle | long | one | | | If applicable, the cycle of therapy that this timepoint represents |
day | long | one | | | If applicable, the day in the cycle of therapy that this timepoint represents |
id | string | one | | | The id of the timepoint. This is unique within the dataset, but not necessarily within the database. If this timepoint
is associated with a treatment regimen, the id must to start with the treatment regimen followed by the
character '/'. The rest of the id is free format |
offset | long | one | | | The offset in number of days (positive or negative) between this specific timepoint and the nominal timepoint
indicate by its :timepoint/attribute. For instance to indicate two timepoints that are 5 days before and after
the first treatment, you would create two timepoint entities both with type :timepoint/treatment1 and with offsets
-5 and +5 respectively |
relative-order | long | one | | | The relative order of this timepoint within its treatment regimen. This field is mandatory for
timepoints that have a :timepoint/treatment-regimen attribute |
treatment-regimen | treatment-regimen | one | | | The treatment regimen that this timepoint is part of. Note that timepoints that have a :timepoint/relative-order
attribute MUST refer to a treatment regimens. Timepoints that do not have such attribute may exist outside
of any treatment-regimen |
type | timepoint.type | one | | | The type of this timepoint, refers to idents in the 'timepoint' namespace. The type of the timepoint is meant to
represent both logical timepoints that exist outside of any chronological timeline (e.g. 'baseline'), as well
as nominal timepoints within a treatment regimen (e.g. 'treatment1'). This field is mandatory |
uid | [[* string]] | one | yes | | Synthetic unique ID for timepoints |