@d4l/collect-lib 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE.md +8 -0
- package/README.md +319 -0
- package/dist/index.d.mts +1129 -0
- package/dist/index.d.ts +1129 -0
- package/dist/index.js +5249 -0
- package/dist/index.js.map +1 -0
- package/dist/index.mjs +5249 -0
- package/dist/index.mjs.map +1 -0
- package/package.json +44 -0
package/LICENSE.md
ADDED
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
(c) 2025 D4L data4life gGmbH / All rights reserved.
|
|
2
|
+
|
|
3
|
+
D4L owns all legal rights, title and interest in and to the Software Development Kit ("SDK"), including any intellectual property rights that subsist in the SDK.
|
|
4
|
+
|
|
5
|
+
The SDK and its documentation may be accessed and used for viewing/review purposes only.
|
|
6
|
+
Any usage of the SDK for other purposes, including usage for the development of applications/third-party applications shall require the conclusion of a license agreement between you and D4L.
|
|
7
|
+
|
|
8
|
+
If you are interested in licensing the SDK for your own applications/third-party applications and/or if you’d like to contribute to the development of the SDK, please contact D4L by email to help@data4life.care.
|
package/README.md
ADDED
|
@@ -0,0 +1,319 @@
|
|
|
1
|
+
# collect-lib
|
|
2
|
+
|
|
3
|
+
Library for reusable functionality of collect (phoenix and research-studio)
|
|
4
|
+
|
|
5
|
+
## Local Development
|
|
6
|
+
|
|
7
|
+
### Phoenix
|
|
8
|
+
|
|
9
|
+
For pure coding `yarn link ../collect-lib` works fine.
|
|
10
|
+
For actually running the app while development we need a workaround:
|
|
11
|
+
|
|
12
|
+
```
|
|
13
|
+
yarn add ../collect-lib
|
|
14
|
+
code ./node_modules/@d4l/collect-lib
|
|
15
|
+
cd node_modules/@d4l/collect-lib
|
|
16
|
+
yarn start
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
React-Native does not work with `yarn link`, because of some symlink issues down the line in metro/expo/whatever.
|
|
20
|
+
To workaround we can install the dependency from local with `yarn add ../phoenix-lib`.
|
|
21
|
+
This will install the library from the local source as a full copy, allowing each `yarn` call to get the recent build.
|
|
22
|
+
From there we can cheat the system by opening the `collect-lib` from inside the `node_modules` of `phoenix` to then working in there.
|
|
23
|
+
Then run `yarn start` to watch changes in the lib and build each time, which should then be picked up by the running UA.
|
|
24
|
+
|
|
25
|
+
### Research Studio
|
|
26
|
+
|
|
27
|
+
```
|
|
28
|
+
npm link ../collect-lib
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
This generally works, but the hot reload doesn't like that the files vanish (on rebuild of the lib) and new builds don't seem to be picked up automatically.
|
|
32
|
+
|
|
33
|
+
## Types
|
|
34
|
+
|
|
35
|
+
The type documentation is generated automatically from the `src/types` files.
|
|
36
|
+
Update the types by running `yarn run readme:update`.
|
|
37
|
+
|
|
38
|
+
<!-- AUTOMATICALLY GENERATED CONTENT -->
|
|
39
|
+
|
|
40
|
+
### Program
|
|
41
|
+
|
|
42
|
+
| Properties | Required | Type | Description |
|
|
43
|
+
| ----------- | -------- | ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
44
|
+
| name | true | string | Name of the program used as primary identifier |
|
|
45
|
+
| tenantID | true | string | Tenant the program belongs to |
|
|
46
|
+
| languages | true | string[] | Language codes that the program is available in. Example: `['en', 'de']` |
|
|
47
|
+
| type | true | `study` or `sensor` | `sensor` is the new research-studio type, `study` is from the study-builder (and older) |
|
|
48
|
+
| phases | true | [ProgramStep](#ProgramStep)[][] | Defines the flow of the program as an array of `phases`. `phases` consist of arrays of `steps`. `phases` are worked through sequentially and `steps` within a single `phase` are parallel. |
|
|
49
|
+
| donation | true | [ProgramDonation](#ProgramDonation) | Donation settings handle which resources are donated, where they are donated to, and how the donation is regulated |
|
|
50
|
+
| content | true | string | Contains all the relevant content properties of the program. |
|
|
51
|
+
| endDate | false | ISO 8601 date with timezone | Date the program should finish for all users. |
|
|
52
|
+
| tags | false | [ProgramTag](#ProgramTag)[] | List of supported tags including their configuration |
|
|
53
|
+
| publishedAt | true | ISO 8601 date with timezone | Date the program was published (used to determine program state). |
|
|
54
|
+
|
|
55
|
+
### ProgramSteps
|
|
56
|
+
|
|
57
|
+
#### Base
|
|
58
|
+
|
|
59
|
+
| Properties | Required | Type | Description |
|
|
60
|
+
| ----------------- | -------- | ------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
|
|
61
|
+
| type | true | string | Defines the type of the step (determines which other attributes are applicable) |
|
|
62
|
+
| required | true | boolean | Defines if the step needs to be completed for the containing phase to count as completed |
|
|
63
|
+
| start | false | [StepCondition](#StepCondition) | Defines condition that starts the step. Using this condition with a survey means there will be an indiviual starting date for each user. |
|
|
64
|
+
| end | false | [StepCondition](#StepCondition) | Defines condition that ends the step. Using this condition with a survey means there will be an indiviual ending date for each user. |
|
|
65
|
+
| requiredCondition | false | [StepCondition](#StepCondition) | Defines condition that overwrites the required property with the evaluation result. |
|
|
66
|
+
|
|
67
|
+
#### Consent Step
|
|
68
|
+
|
|
69
|
+
| Properties | Required | Type | Description |
|
|
70
|
+
| ---------- | -------- | --------- | --------------------------------------------------------------------- |
|
|
71
|
+
| type | true | `consent` | Step that requires a consent to be given |
|
|
72
|
+
| consentKey | true | string | Identifies which consent this step refers to |
|
|
73
|
+
| minVersion | false | number | Denotes the minimum version of the consent which needs to be accepted |
|
|
74
|
+
|
|
75
|
+
#### Token Step
|
|
76
|
+
|
|
77
|
+
| Properties | Required | Type | Description |
|
|
78
|
+
| ----------- | -------- | ------- | ------------------------------------------------------------- |
|
|
79
|
+
| type | true | `token` | Step that requires a token (participation code) to be entered |
|
|
80
|
+
| tokenLength | true | number | number of characters in the token |
|
|
81
|
+
|
|
82
|
+
#### Survey Step
|
|
83
|
+
|
|
84
|
+
| Properties | Required | Type | Description |
|
|
85
|
+
| ---------- | -------- | -------- | ------------------------------------------------------------------------------------------------ |
|
|
86
|
+
| type | true | `survey` | Step that requires a survey to be answered at least once |
|
|
87
|
+
| surveyName | true | string | Identifies which survey this step refers to |
|
|
88
|
+
| standalone | false | boolean | Denotes if this survey is a standalone survey that does not belong to this program specifically. |
|
|
89
|
+
|
|
90
|
+
#### Routine Step
|
|
91
|
+
|
|
92
|
+
| Properties | Required | Type | Description |
|
|
93
|
+
| ----------- | -------- | --------- | --------------------------------------------------------- |
|
|
94
|
+
| type | true | `routine` | Step that requires a routine to be executed at least once |
|
|
95
|
+
| routineName | true | string | Identifies which routine this step refers to |
|
|
96
|
+
|
|
97
|
+
#### Display Step
|
|
98
|
+
|
|
99
|
+
| Properties | Required | Type | Description |
|
|
100
|
+
| ----------- | -------- | --------- | --------------------------------------------------------------- |
|
|
101
|
+
| type | true | `display` | Step that requires a display to be shown |
|
|
102
|
+
| displayName | true | string | Identifies which display this step refers to |
|
|
103
|
+
| isCompleted | false | boolean | If true marks the program as completed once this step is shown. |
|
|
104
|
+
|
|
105
|
+
#### Eligibility Step
|
|
106
|
+
|
|
107
|
+
| Properties | Required | Type | Description |
|
|
108
|
+
| ---------- | -------- | ----------------------- | ------------------------------------------------------------------------------------------------------------------ |
|
|
109
|
+
| type | true | `eligbility` | Step that requires an eligibility test to be passed |
|
|
110
|
+
| surveyName | true | string | Identifies which survey is asked for eligibility determination |
|
|
111
|
+
| threshold | true | [Threshold](#Threshold) | required for type `eligibility` - Defines the score condition that must be fulfilled to pass the eligibility test. |
|
|
112
|
+
| standalone | false | boolean | Denotes if the survey for this eligbility step is one that does not belong to this program specifically. |
|
|
113
|
+
|
|
114
|
+
##### Threshold
|
|
115
|
+
|
|
116
|
+
| Properties | Required | Type | Description |
|
|
117
|
+
| ---------- | -------- | ------------------------------------------------- | ----------------------------------------------------------------------- |
|
|
118
|
+
| operator | true | `exists`, `eq`, `neq`, `lt`, `lteq`, `gt`, `gteq` | Defines the operator to use for the threshold |
|
|
119
|
+
| value | true | number | Defines the number to be used with the operator to define the threshold |
|
|
120
|
+
|
|
121
|
+
#### Sensor Step
|
|
122
|
+
|
|
123
|
+
| Properties | Required | Type | Description |
|
|
124
|
+
| ---------- | -------- | ----------------------------------- | ----------------------------------------------------------------------------------- |
|
|
125
|
+
| type | true | `sensor` | Step that sets up passive data collection |
|
|
126
|
+
| devices | true | [ProgramDevices](#ProgramDevices)[] | List of supported devices including their configuration for passive data collection |
|
|
127
|
+
|
|
128
|
+
### StepCondition
|
|
129
|
+
|
|
130
|
+
| Properties | Required | Type | Description |
|
|
131
|
+
| ------------ | -------- | ----------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
132
|
+
| type | true | [ConditionType](#ConditionType) | Type of the condition (determines which other attributes are applicable) |
|
|
133
|
+
| surveyName | false | string | required for condition type `survey` and `question` |
|
|
134
|
+
| routineName | false | string | required for condition type `routine` |
|
|
135
|
+
| linkID | false | string | required for condition type `question` |
|
|
136
|
+
| questionType | false | `coding`, `date` | required for condition type `question` - defines the data type of the referred to question |
|
|
137
|
+
| operand | false | string | required for condition type `question` (unless operator is `exists`). Used as `<answer>` `<operator>` `<operand>`. |
|
|
138
|
+
| operator | false | `exists`,`=`,`!=`,`>`,`<`,`>=`,`<=` | Required for condition type `question`. Used as `<answer>` `<operator>` `<operand>`. |
|
|
139
|
+
| offset | false | ISO 8601 duration string | Defines the offset between the answer date and the current date. For question type `coding` only impacts the start/end date calculation. For type `offset` impacts the `item`. For type `consent`, this is applied to the date of the consent grant |
|
|
140
|
+
| item | false | StepCondition | Required for condition type `not` and `offset`. |
|
|
141
|
+
| items | false | StepCondition[] | Required for condition type `and` and `or`. List of conditions that are combined with the respective operator. |
|
|
142
|
+
| sorting | false | `earliest`, `latest` | Used for condition type `and` and `or`. Determines which resulting dates of the items gets picked. Defaults to `earliest` for `or` and `latest` for `and`. |
|
|
143
|
+
| consentKey | false | string | Required for condition type `consent`. Reference to the consent that must have been granted to fulfill the condition. |
|
|
144
|
+
|
|
145
|
+
#### ConditionType
|
|
146
|
+
|
|
147
|
+
| Type | Description |
|
|
148
|
+
| -------- | ----------------------------------------------------------------------------------- |
|
|
149
|
+
| question | Condition that requires a specific answer from a previous survey |
|
|
150
|
+
| survey | Condition that requires a previous survey to have been completed |
|
|
151
|
+
| routine | Condition that requires a previous routine to have been completed |
|
|
152
|
+
| and | Condition that requires all subconditions to be fulfilled |
|
|
153
|
+
| or | Condition that requires one subcondition to be fulfilled |
|
|
154
|
+
| offset | Condition that adds a date offset to the fulfillment date of the given subcondition |
|
|
155
|
+
| consent | Condition that require a specific consent to be given |
|
|
156
|
+
|
|
157
|
+
### ProgramDonation
|
|
158
|
+
|
|
159
|
+
| Properties | Required | Type | Description |
|
|
160
|
+
| ---------------------- | -------- | --------------------------------------------- | ----------------------------------------------------------------------------------------------- |
|
|
161
|
+
| donation.consentKey | false | string | The consent key identifying the consent the user has to sign for data donation in this program. |
|
|
162
|
+
| donation.delay | true | number | The number of days after which a resource can be donated. |
|
|
163
|
+
| donation.revocation | true | `delete`, `anonymize` | Determines what happens to the data after donation was revoked. Defaults to `delete`. |
|
|
164
|
+
| donation.anonymization | false | [ProgramAnonymization](#ProgramAnonymization) | The set of the anonymization functions which should be applied to all resources of the program. |
|
|
165
|
+
| donation.target | true | string | The target which should be used for data donation. |
|
|
166
|
+
|
|
167
|
+
#### ProgramAnonymization
|
|
168
|
+
|
|
169
|
+
| Properties | Required | Type | Description |
|
|
170
|
+
| ------------- | -------- | --------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
|
|
171
|
+
| blur | false | object | The set of blurring settings that should be applied to the resource. |
|
|
172
|
+
| blur.location | true | string | The timezone location of the resource, e.g `"Europe/Berlin"`. |
|
|
173
|
+
| blur.authored | false | [DateBlurringFunction](#DateBlurringFunction) | The name of the default blurring function which is used to blur the authored timestamp of every QuestionnaireResponse. |
|
|
174
|
+
| blur.authored | false | [DateBlurringFunction](#DateBlurringFunction) | The name of the default blurring function which is used to blur the period start and end of every ResearchSubject. |
|
|
175
|
+
|
|
176
|
+
#### DateBlurringFunction
|
|
177
|
+
|
|
178
|
+
| Type | Description |
|
|
179
|
+
| ------------ | ------------------------------------------------ |
|
|
180
|
+
| startOfDay | Sets time to the start of the day (00:00:00) |
|
|
181
|
+
| endOfDay | Sets time to the end of the day (23:59:59.99...) |
|
|
182
|
+
| startOfWeek | Sets date to the start of monday |
|
|
183
|
+
| endOfWeek | Sets date to the end of sunday |
|
|
184
|
+
| startOfMonth | Sets date to the start of the first of the month |
|
|
185
|
+
| endOfMonth | Sets date to the end of the last of th month |
|
|
186
|
+
|
|
187
|
+
#### ProgramContent
|
|
188
|
+
|
|
189
|
+
| Properties | Required | Type | Description |
|
|
190
|
+
| ------------------------ | -------- | -------------------- | -------------------------------------------------------- |
|
|
191
|
+
| title | true | {language: string} | Display title of the program. |
|
|
192
|
+
| description | true | {language: string} | Display description of the program. |
|
|
193
|
+
| contact | true | {language: string} | Contact information to display for the user. |
|
|
194
|
+
| image | false | data URI encoded svg | Image of the program |
|
|
195
|
+
| privacyPolicy | false | object | requires `text` |
|
|
196
|
+
| participationInformation | false | object | requires `text` |
|
|
197
|
+
| eligibility | false | object | requires `title`, `description`, `include` and `exclude` |
|
|
198
|
+
|
|
199
|
+
#### ProgramTag
|
|
200
|
+
|
|
201
|
+
| Properties | Required | Type | Description |
|
|
202
|
+
| ------------- | -------- | --------------------------------- | ----------------------------------------------- |
|
|
203
|
+
| code | true | string | The code identifying this tag |
|
|
204
|
+
| labels | true | TranslatedString | Set of human readable translations for this tag |
|
|
205
|
+
| effectiveType | true | 'dateTime', 'period' or 'unknown' | The type of tag |
|
|
206
|
+
|
|
207
|
+
### Survey
|
|
208
|
+
|
|
209
|
+
| Properties | Required | Type | Description |
|
|
210
|
+
| ----------- | -------- | ------------------------------- | -------------------------------------------------------------------------------- |
|
|
211
|
+
| name | true | string | Primary identifier. Assumption: survey and routine names are collectively unique |
|
|
212
|
+
| programName | true | string | The name of the program the survey belongs to |
|
|
213
|
+
| frequency | true | [TaskFrequency](#TaskFrequency) | Defines in which frequency the questionnaire occurs |
|
|
214
|
+
| scoring | true | [SurveyScoring](#SurveyScoring) | Defines the texts, images and icons that need to be displayed for the survey |
|
|
215
|
+
| content | true | [SurveyContent](#SurveyContent) | Defines the texts, images and icons that need to be displayed for the survey |
|
|
216
|
+
|
|
217
|
+
#### TaskFrequency
|
|
218
|
+
|
|
219
|
+
| Properties | Required | Type | Description |
|
|
220
|
+
| ------------ | -------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
221
|
+
| type | true | [FrequencyType](#FrequencyType) | Defines how often and when a questionnaire is triggered/added for the survey |
|
|
222
|
+
| start | true | ISO 8601 date with timezone | Determines the global starting date of the survey. The time component is also used for when the events should be available on the day they become available. |
|
|
223
|
+
| end | false | ISO 8601 date with timezone | Determines the global ending date of the survey. When snapshotting this might be overwritten with the program end date if that is earlier. |
|
|
224
|
+
| location | false | Timezone Location | Determines the location for the defined date, so that timezone problems can be handled. |
|
|
225
|
+
| factor | false | integer | For `daily`, `weekly` and `monthly` this factor is used to manipulate the cycle length, e.g. `daily` with a factor of 7 makes it a survey that is repeated every week, but doesn't necessarily start on monday. |
|
|
226
|
+
| editDuration | false | ISO 8601 duration string | Enables editing events of this survey for the given duration. |
|
|
227
|
+
| skipFirst | false | boolean | Determines if the first iteration of the survey after subscription should be skipped. Skipping it means the questionnaire won't open in the middle of the window and instead at the start of the next full window. Defaults to `false`. |
|
|
228
|
+
|
|
229
|
+
#### SurveyScoring
|
|
230
|
+
|
|
231
|
+
| Properties | Required | Type | Description |
|
|
232
|
+
| ---------------- | -------- | --------------------------------------------- | ---------------------------------------------------------------------------------- |
|
|
233
|
+
| scores | true | object | Defines how the questions will be scored |
|
|
234
|
+
| scores.valueset | false | {valuesetURL: {answerCode: score}} | For questions that use valuesets scores are assigned to each code of the valuesets |
|
|
235
|
+
| scores.number | false | {linkId: [ScoreThreshold](#ScoreThreshold)[]} | For numeric questions we define scoring conditions per question |
|
|
236
|
+
|
|
237
|
+
#### ScoreThreshold
|
|
238
|
+
|
|
239
|
+
| Properties | Required | Type | Description |
|
|
240
|
+
| ---------- | -------- | -------------------------------- | -------------------------------------------------------------------- |
|
|
241
|
+
| operator | true | `eq`, `lt`, `lteq`, `gt`, `gteq` | Defines the operator to use with the threshold |
|
|
242
|
+
| threshold | true | number | Threshold that is used with the operator |
|
|
243
|
+
| score | true | number | Score that is added when the operator and threshold condition is met |
|
|
244
|
+
|
|
245
|
+
#### FrequencyType
|
|
246
|
+
|
|
247
|
+
| Type | Description |
|
|
248
|
+
| -------- | --------------------------------------------------------- |
|
|
249
|
+
| single | Occurs only once |
|
|
250
|
+
| daily | Occurs every day |
|
|
251
|
+
| weekly | Occurs every Monday |
|
|
252
|
+
| monthly | Occurs every 1st of a month |
|
|
253
|
+
| onDemand | There is a button that allows you to add one at any point |
|
|
254
|
+
|
|
255
|
+
#### SurveyContent
|
|
256
|
+
|
|
257
|
+
| Properties | Required | Type | Description |
|
|
258
|
+
| ------------------- | -------- | -------------------- | ------------------------------------------ |
|
|
259
|
+
| default | true | object | Default values for survey texts and images |
|
|
260
|
+
| default.title | true | {[language]: text} | Survey title in available languages |
|
|
261
|
+
| default.description | false | {[language]: text} | Survey description in available languages |
|
|
262
|
+
| default.image | false | data URI encoded svg | Survey image in html usable format |
|
|
263
|
+
| default.icon | false | data URI encoded svg | Survey icon in html usable format |
|
|
264
|
+
|
|
265
|
+
### Routine
|
|
266
|
+
|
|
267
|
+
| Properties | Required | Type | Description |
|
|
268
|
+
| ----------- | ------------------------ | ----------------------------------- | -------------------------------------------------------------------------------- |
|
|
269
|
+
| name | true | string | Primary identifier. Assumption: survey and routine names are collectively unique |
|
|
270
|
+
| programName | true | string | The name of the program the routine belongs to |
|
|
271
|
+
| frequency | true | [TaskFrequency](#TaskFrequency) | Defines in which frequency the questionnaire occurs |
|
|
272
|
+
| content | true | [RoutineContent](#RoutineContent) | Defines the texts, images and icons that need to be displayed for the routine |
|
|
273
|
+
| devices | true | string[] | Lists the devices used in the routine |
|
|
274
|
+
| duration | ISO 8601 duration String | Defines the duration of the routine |
|
|
275
|
+
|
|
276
|
+
#### ProgramDevice
|
|
277
|
+
|
|
278
|
+
| Properties | Required | Type | Description |
|
|
279
|
+
| ------------- | -------- | --------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
|
280
|
+
| type | true | [ProgramDeviceType](#ProgramDeviceType) | Device identifier |
|
|
281
|
+
| streamingMode | false | string | Device specific streaming mode to use for data types |
|
|
282
|
+
| dataTypes | true | [ProgramDevicesDataType](#ProgramDevicesDataType)[] | List of data types to collect |
|
|
283
|
+
| labels | true | [ProgramDevicesLabel](#ProgramDevicesLabel)[] | List of labels |
|
|
284
|
+
| outputRate | false | number | Sampling rate in hz |
|
|
285
|
+
| sensorDelay | false | number | Sensor delay as per Android constants https://developer.android.com/reference/android/hardware/SensorManager#SENSOR_DELAY_FASTEST |
|
|
286
|
+
| clientID | false | string | ClientID required to request data via API |
|
|
287
|
+
|
|
288
|
+
#### RoutineContent
|
|
289
|
+
|
|
290
|
+
| Properties | Required | Type | Description |
|
|
291
|
+
| ------------- | -------- | ------------------------------------------- | ------------------------------------------- |
|
|
292
|
+
| default | true | object | Default values for routine texts and images |
|
|
293
|
+
| default.title | true | {[language]: text} | Routine title in available languages |
|
|
294
|
+
| steps | true | [RoutineContentStep[]](#RoutineContentStep) | Routine steps |
|
|
295
|
+
|
|
296
|
+
#### RoutineContentStep
|
|
297
|
+
|
|
298
|
+
| Properties | Required | Type | Description |
|
|
299
|
+
| ---------- | -------- | ------------------------------------------------ | -------------------------------------------- |
|
|
300
|
+
| title | true | {[language]: text} | Step title in available languages |
|
|
301
|
+
| blocks | true | {image?: text, instructions: {[language]: text}} | Step blocks including image and instructions |
|
|
302
|
+
|
|
303
|
+
### Display
|
|
304
|
+
|
|
305
|
+
| Properties | Required | Type | Description |
|
|
306
|
+
| ----------- | -------- | --------------------------------- | -------------------------------------------------------------------------------- |
|
|
307
|
+
| name | true | string | Primary identifier. Assumption: survey and display names are collectively unique |
|
|
308
|
+
| programName | true | string | The name of the program the display belongs to |
|
|
309
|
+
| displayType | true | 'report' / 'recommendation' | The type of the display (report or recommendation) |
|
|
310
|
+
| frequency | true | [TaskFrequency](#TaskFrequency) | Defines in which frequency the questionnaire occurs |
|
|
311
|
+
| content | true | [DisplayContent](#DisplayContent) | Defines the texts, images and icons that need to be displayed for the display |
|
|
312
|
+
|
|
313
|
+
#### DisplayContent
|
|
314
|
+
|
|
315
|
+
| Properties | Required | Type | Description |
|
|
316
|
+
| --------------- | -------- | ------------------ | ------------------------------------------- |
|
|
317
|
+
| default | true | object | Default values for display texts and images |
|
|
318
|
+
| default.title | true | {[language]: text} | Display title in available languages |
|
|
319
|
+
| default.message | true | {[language]: text} | Display message in available languages |
|