Available exports

Warning

This feature is not yet complete and might be subject to more minor changes.

This document all the exports that are available through the API of the Minddistrict platform. For each export, you have a table that lists which properties are available and how they are encoded. For each property, the following notes can be used:

default

This property is included by default: if you do not specify a specific list of properties with your export, this property will be included in the result.

private

This property potentially contains privacy sensitive information. In order to be included in an export, the export need to be created by a user that is in the data officer group.

file

This property or one of its sub-properties may contain a file.

General remarks

  • It is possible that for a given export no data is available in the Minddistrict platform. In this case the export will fail with the error Export not available.

  • All information was not always recorded in the past. For old data, some properties, for instance, creation time, completion time, state changes might not always be present for every record.

  • All database identifiers for clients, anonymous clients, friends and professionals are unique between each others.

  • In all exports, for both content and template, the title is only unique for a given identifier and a version.

  • Users created through a Koppeltaal or an HL7 connection will not have a creator reported in the export.

List of properties per export

Clients

Name

Value

Explanation

Value type

Notes

Profile details

name

Name

Full name of the client.

Text

default, private
first name

First name

First name of the client.

Text

private
infix

Infix

Last name preposition of the client.

Text

private
last name

Last name

Last name of the client.

Text

private
email

Email

Email of the client.

Text

default, private
bsn

BSN

Citizen service number of the client.

Text

private
phone number

Phone number

Phone number of the client.

Text

private
gender

Gender

Gender of the client.

Text

private
date of birth

Date of birth

Date of birth of the client.

Date

private
picture

Profile picture

Profile picture of the client.

File

private, file

IDs

database id

Database ID

Internal database identifier of the client.

Text

default
id

External ID

External identifier of the client, provided by the platform owner.

Text

private
creator

Creator ID

Database identifier of the user who created this client.

Text

default

Date and time

creation

Creation

Date and time when this client was created.

Date and time

default
last usage

Last active

Date on which the client was last active.

Date

Other

active

Active

Whether the client is active or inactive.

Boolean

labels

Labels

Labels applied to the client.

List of text

external_source

External source of information

Name of the external information source or API user identifier.

Text

private

This export is identified by the name: client.

Remarks

  • A client account can be a friend account that as been upgraded to a client account and therefore has been created by an another client.

Anonymous clients

Name

Value

Explanation

Value type

Notes

Profile details

name

Name

Full name of the anonymous client.

Text

default, private
nickname

Nickname

Nickname of the anonymous client.

Text

private
email

Email

Email of the anonymous client.

Text

default, private
gender

Gender

Gender of the anonymous client.

Text

private
age

Age

Age of the anonymous client.

Integer

private
picture

Profile picture

Profile picture of the anonymous client.

File

private, file

IDs

database id

Database ID

Internal database identifier of the anonymous client.

Text

default
id

External ID

External identifier of the anonymous client, provided by the platform owner.

Text

private
creator

Creator ID

Database identifier of the user who created this anonymous client.

Text

default

Date and time

creation

Creation

Date and time when this anonymous client was created.

Date and time

default
last usage

Last active

Date on which the anonymous client was last active.

Date

Other

active

Active

Whether the anonymous client is active or inactive.

Boolean

labels

Labels

Labels applied to the anonymous client.

List of text

external_source

External source of information

Name of the external information source or API user identifier.

Text

private

This export is identified by the name: anonymous client.

Remarks

  • An anonymous client can only be created through an anonymous sign-up,

  • An anonymous client can be identified by a secretary and then become a full-fledged client.

Professionals

Name

Value

Explanation

Value type

Notes

Profile details

name

Name

Full name of the professional.

Text

default, private
first name

First name

First name of the professional.

Text

private
infix

Infix

Last name preposition of the professional.

Text

private
last name

Last name

Last name of the professional.

Text

private
email

Email

Email of the professional.

Text

default, private
picture

Profile picture

Profile picture of the professional.

File

private, file

IDs

database id

Database ID

Internal database identifier of the professional.

Text

default
id

External ID

External identifier of the professional, provided by the platform owner.

Text

private
creator

Creator ID

Database identifier of the user who created this professional.

Text

default
group ids

Group IDs

Group identifiers the professional belongs to.

List of text

Date and time

creation

Creation

Date and time when this professional was created.

Date and time

default
last usage

Last active

Date on which the professional was last active.

Date

Other

active

Active

Whether the professional is active or inactive.

Boolean

labels

Labels

Labels applied to the professional.

List of text

external_source

External source of information

Name of the external information source or API user identifier.

Text

private

This export is identified by the name: professional.

Remarks

  • Professional accounts created by the Minddistrict service desk will not have its creator reported in the export.

Friends

Name

Value

Explanation

Value type

Notes

IDs

database id

Database ID

Internal database identifier of the friend.

Text

default
creator

Creator ID

Database identifier of the user who created this friend.

Text

default

Date and time

creation

Creation

Date and time when this friend was created.

Date and time

default
last usage

Last active

Date on which the friend was last active.

Date

Other

active

Active

Whether the friend is active or inactive.

Boolean

This export is identified by the name: friend.

Remarks

  • Existing friends accounts can be converted to clients if they are added as such in the platform,

  • Friends accounts are created by the first client who invites them,

  • For privacy reasons, Minddistrict does not leak the identity behind a friend account to a customer. Therefore this export does not contains any identifiable information.

API Users

Name

Value

Explanation

Value type

Notes

Profile details

name

Name

Full name of the API user.

Text

default

IDs

database id

Database ID

Internal database identifier of the API user.

Text

default
creator

Creator ID

Database identifier of the user who created this API user.

Text

default

Date and time

creation

Creation

Date and time when this API user was created.

Date and time

default
last usage

Last active

Date on which the API user was last active.

Date

Other

active

Active

Whether the API user is active or inactive.

Boolean

This export is identified by the name: api user.

Sign-up applications

Name

Value

Explanation

Value type

Notes

Profile details

code

Code

Unique sign up code associated with the sign up application.

Text

default
first name

First name

First name of the user on the sign up application.

Text

private
infix

Infix

Last name preposition of the user on the sign up application.

Text

private
last name

Last name

Last name of the user on the sign up application.

Text

private
email

Email

Email of the user on the sign up application.

Text

default, private
bsn

BSN

Citizen service number of the user on the sign up application.

Text

private
phone number

Phone number

Phone number of the user on the sign up application.

Text

private
gender

Gender

Gender of the user on the sign up application.

Text

private
date of birth

Date of birth

Date of birth of the user on the sign up application.

Date

private

IDs

client database id

Client/friend database ID

Internal database identifier of the client or friend.

Text

default
database id

Database ID

Internal database identifier of the application.

Text

default

Lifecycle

creation

Creation

Date and time of sign up.

Date and time

default
state

State

Snapshots of the state changes of the sign up.

List of object

default

This export is identified by the name: signup.

The list of object state contains:

Name

Value

Explanation

Value type

Notes

change

Changed value

New state after the change.

Text

default
changed when

When

When did the change happen.

Date and time

default

Remarks

  • Anonymous sign-up applications are in a different export.

  • If a code is generated, the signup is created when then code is generated, but the properties on the signup are only filled in when the code redeemed.

  • Sign-up will create a client if it is accepted by a secretary.

Anonymous sign-up applications

Name

Value

Explanation

Value type

Notes

Profile details

code

Code

Unique sign up code associated with the sign up application.

Text

default
nickname

Nickname

Nickname of the user on the sign up application.

Text

private
email

Email

Email of the user on the sign up application.

Text

default, private
gender

Gender

Gender of the user on the sign up application.

Text

private
age

Age

Age of the user on the sign up application.

Integer

private

IDs

client database id

Client/friend database ID

Internal database identifier of the client or friend.

Text

default
database id

Database ID

Internal database identifier of the application.

Text

default

Lifecycle

creation

Creation

Date and time of sign up.

Date and time

default
state

State

Snapshots of the state changes of the sign up.

List of object

default

This export is identified by the name: anonymous signup.

The list of object state contains:

Name

Value

Explanation

Value type

Notes

change

Changed value

New state after the change.

Text

default
changed when

When

When did the change happen.

Date and time

default

Remarks

  • If a code is generated, the signup is created when then code is generated, but the properties on the signup are only filled in when the code redeemed.

  • Anonymous sign-up will create an anonymous client if it is accepted by a secretary.

Relations between clients and professionals

Name

Value

Explanation

Value type

Notes

IDs

professional database id

Professional database ID

Internal database identifier for the professional.

Text

default
client database id

Client database ID

Internal database identifier for the client.

Text

default

Date and time

creation

Creation

Date and time when this relation was created.

Date and time

default

Other

predicate

Relation predicate

Type of relation between the client and the professional.

Text

default

This export is identified by the name: relation.

User activity period

Name

Value

Explanation

Value type

Notes

Users

user database id

User database ID

Internal database identifier for the user.

Text

default
user type

User type

User type

Text

default

General

activity period

Activity period

Start of a six hour period in which the user was active in the platform

Date and time

default
web

Active on web

User was active on the platform from the web

Boolean

default
mobile

Active on mobile

User was active on the platform from a mobile app

Boolean

default

This export is identified by the name: user activity period.

User login

Name

Value

Explanation

Value type

Notes

Users

user database id

User database ID

Internal database identifier for the user.

Text

default
user type

User type

User type

Text

default

General

timestamp

Login timestamp

Login timestamp

Date and time

default

This export is identified by the name: user login.

Messages

Name

Value

Explanation

Value type

Notes

IDs

id

Database ID

Internal database identifier of the message.

Text

default
conversation id

Conversation ID

Database identifier of the conversation to which this message belongs to.

Text

default
sender

Sender

Database identifier of the user who sent the message.

Text

default
recipient

Recipient

Database identifier of the users who received the message.

List of object

default

Message content

subject

Subject

Subject of the conversation.

Text

default, private
body

Body

Text that was sent in the message.

Text

default, private
attachments

Attachments

If available, attachments that are sent within the message.

List of file

private, file

Date and time

sent on

Sent on

Date and time on which the message has been sent.

Date and time

default

This export is identified by the name: message.

The list of object recipient contains:

Name

Value

Explanation

Value type

Notes

id

Database ID

Database identifier of the user who read the message.

Text

default
read message on

Date and time

Date and time at which the user read the message.

Date and time

default

Video usage by professionals

Name

Value

Explanation

Value type

Notes

Users

professional database id

Professional database ID

Internal database identifier for the professional.

Text

default

General

total calls

Total calls

Total number of calls

Integer

default
total calls duration

Total calls duration

Total duration of all calls in minutes

Integer

default

Client calls

client calls

Client one-on-one calls

Number of one-on-one calls with clients

Integer

client calls duration

Client one-on-one calls duration

Duration of one-on-one calls with clients in minutes

Integer

client group calls

Client group calls

Number of calls with multiple clients

Integer

client group calls duration

Client group calls duration

Duration of calls with multiple clients in minutes

Integer

Professional calls

professional calls

Professional one-on-one calls

Number of one-on-one calls with professionals

Integer

professional calls duration

Professional one-on-one calls duration

Duration of one-on-one calls with professionals in minutes

Integer

professional group calls

Professional group calls

Number of calls with multiple professionals

Integer

professional group calls duration

Professional group calls duration

Duration of calls with multiple professionals in minutes

Integer

Other

other calls

Other calls

Number of “other” calls

Integer

other calls duration

Other calls duration

Duration of “other” calls in minutes

Integer

This export is identified by the name: video usage by professionals.

This export supports the following optional parameters:

Name

Value

Explanation

Value type

Allowed operator

period

Period

Time period on which the video usage is computed

Date and time

ge, gt, le, lt

Diary entries

Name

Value

Explanation

Value type

Notes

Users

client database id

Client/friend database ID

Internal database identifier of the client or friend.

Text

default
professional database id

Professional database ID

Internal database identifier for the professional.

Text

default

General

id

Entry ID

Database identifier for this diary entry.

Text

default

Content

content

Content

Diary content on which this entry is based.

Object

default

Date and time

entry time

Date and time of the diary entry

Date and time as submitted by the user

Date and time

default

Answers

answers

Answers

Answers to the questions.

List of object

default, file
computation results

Computation results

Computation results for the provided answers.

List of object

default

Lifecycle

creation

Creation

Date and time when this diary entry was created.

Date and time

default

Other

labels

Labels

Labels applied to this diary entry.

List of text

This export is identified by the name: diary entry.

The object content contains:

Name

Value

Explanation

Value type

Notes

id

Content identifier

-

Text

default
title

Content title

-

Text

default
version

Content version

-

Integer

default

The list of object answers contains:

Name

Value

Explanation

Value type

Notes

key

Question ID

-

Text

default
value

Answer given

-

JSON data

default, private, file

The list of object computation results contains:

Name

Value

Explanation

Value type

Notes

key

Computation identifier

-

Text

default
value

Computed value

-

JSON data

default, private

Modules in module list

Name

Value

Explanation

Value type

Notes

Users

client database id

Client/friend database ID

Internal database identifier of the client or friend.

Text

default
professional database id

Professional database ID

Internal database identifier for the professional.

Text

default

General

module list id

Module list ID

Database identifier of the module list that the module is in.

Text

default
module id

Module ID

Database identifier of the module.

Text

default

Content

content

Content

Topic in which this module is included.

Object

default
latest completed step

Latest completed step

Latest completed step in the module

Object

default
total steps

Total number of steps

Total number of steps in the module as experienced by the user.

Integer

default

IDs

creator

Creator ID

Database identifier of the user who created this module.

Text

default
creator user type

Creator user type

Type of user who created this module.

Text

default

Lifecycle

creation

Creation

Date and time when this module was created.

Date and time

default
completion

Completion

Date and time when this module was completed.

Date and time

default

This export is identified by the name: modules in module list.

The object content contains:

Name

Value

Explanation

Value type

Notes

id

Content identifier

-

Text

default
title

Content title

-

Text

default
version

Content version

-

Integer

default

The object latest completed step contains:

Name

Value

Explanation

Value type

Notes

offset

Offset of step in module

-

Integer

default
timestamp

Date and time of latest completed step

-

Date and time

default

Remarks

  • Multiple topics can be added to the same module list, they will create multiple modules within it.

  • This export only exports modules in a module list.

Module steps

Name

Value

Explanation

Value type

Notes

Users

client database id

Client/friend database ID

Internal database identifier of the client or friend.

Text

default
professional database id

Professional database ID

Internal database identifier for the professional.

Text

default

General

module id

Module ID

Database identifier for the module that the module step is in.

Text

default
module list id

Module list ID

Database identifier for the module list that the module is in.

Text

default
module list title

Module list title

Title of the module list.

Text

default, private
maximum visible offset

Maximum visible offset

Maximum visible offset in the module as experienced by the user.

Integer

default
favorite

Favorite

Whether this module step is a favorite or not.

Boolean

default

Content

content

Content

Topic in which this module step is included.

Object

default
origin

Content origin

Topic or reusable pages in which this module step was originally written.

Object

default
title

Title of module step

Title of the module step.

Text

default
type

Type

Type of module step.

Text

default
offset

Offset

Offset of the module step in the module as experienced by the user.

Integer

default
offset in content

Offset in content

Offset of the module step in the topic as defined by the author.

Integer

default
offset in origin

Offset in origin

Offset of the module step in the topic or reusable pages in which this step was originally written.

Integer

default

Answers

answers

Answers

Answers to the questions.

List of object

default
raw answers

Raw answers

Raw answers to the questions based on unique identifiers.

List of object

Feedback

require feedback

Require feedback

Is feedback required for the module step or not.

Boolean

default
conversation id

Conversation ID

Database identifier for the conversation related to the module step.

Text

default

Lifecycle

creation

Creation time

Date and time when this module step was created.

Date and time

default
completion

Completion time

Date and time when this module step was completed.

Date and time

default
state

State

Current state for the module step.

Text

default

Other

labels

Labels

Labels applied to this module step.

List of text

This export is identified by the name: module step.

The object content contains:

Name

Value

Explanation

Value type

Notes

id

Content identifier

-

Text

default
title

Content title

-

Text

default
version

Content version

-

Integer

default

The object origin contains:

Name

Value

Explanation

Value type

Notes

id

Content identifier

-

Text

default
title

Content title

-

Text

default
version

Content version

-

Integer

default

The list of object answers contains:

Name

Value

Explanation

Value type

Notes

key

Question identifier

-

Text

default
value

Answer given

-

JSON data

default, private

The list of object answers contains:

Name

Value

Explanation

Value type

Notes

key

Question identifier

-

Text

default
value

Answer given

-

JSON data

default, private

Remarks

  • Multiple topics can be added to the same module list, they will create multiple modules within it.

  • Module steps export includes only the modules created from a topic.

Module sessions

Name

Value

Explanation

Value type

Notes

Users

client database id

Client/friend database ID

Internal database identifier of the client or friend.

Text

default
professional database id

Professional database ID

Internal database identifier for the professional.

Text

default

General

id

Session ID

Database identifier for this module session.

Text

default
module id

Module ID

Database identifier for the module that the session is in.

Text

default
module title

Module title

Title for the module that the session is in.

Text

default, private

Content

content

Content

Content document that this module session consists of.

Object

default
template

Template

Content template that this module session is in.

Object

default

Answers

answers

Answers

Answers to the questions.

List of object

default
computation results

Computation results

Computation results for the provided answers.

List of object

default

Feedback

guided

Guided

Whether this session is guided or not.

Boolean

default
feedback

Feedback

Therapist feedback for this session.

Object

default

Lifecycle

creation

Creation

Date and time when this module session was created.

Date and time

default
first seen on

First seen on

Date and time when this was first seen.

Date and time

default
completion

Completion

Date and time when this module session was completed.

Date and time

default
state

State

Snapshots of the state changes of the module session.

List of object

default

Other

labels

Labels

Labels applied to this module session.

List of text

product feedback

Product feedback

Feedback about the module clients gave.

List of object

default

This export is identified by the name: module session.

The object content contains:

Name

Value

Explanation

Value type

Notes

id

Content identifier

-

Text

default
title

Content title

-

Text

default
version

Content version

-

Integer

default

The object template contains:

Name

Value

Explanation

Value type

Notes

id

Content identifier

-

Text

default
title

Content title

-

Text

default
version

Content version

-

Integer

default

The list of object state contains:

Name

Value

Explanation

Value type

Notes

change

Changed value

New state after the change.

Text

default
changed when

When

When did the change happen.

Date and time

default

The object feedback contains:

Name

Value

Explanation

Value type

Notes

text

Text

Text given as feedback

Text

default, private
therapist

Professional database identifier

Database identifier for the therapist who gave the feedback.

Text

default
when

Date

Date when the feedback was provided.

Date and time

default

The list of object answers contains:

Name

Value

Explanation

Value type

Notes

key

Question identifier

-

Text

default
value

Answer given

-

JSON data

default, private

The list of object product feedback contains:

Name

Value

Explanation

Value type

Notes

when

When

When was the feedback filled in.

Date and time

default
question

Question

Feedback question.

Text

default
answer

Answer

Feedback answer.

Text

default

The list of object computation results contains:

Name

Value

Explanation

Value type

Notes

key

Computation identifier

-

Text

default
value

Computed value

-

JSON data

default, private

Remarks

  • It is possible to create an empty module not based on a template.

  • It is possible to add individual sessions to any existing module. In this case the sessions will not have any template information.

  • It is possible to add individual templates to any existing module. Because of this, it is possible that a module contains sessions coming from different templates, or that a template is repeated inside a module.

  • It is possible to remove or reorganize sessions in an existing module as long as the client did not see them.

  • There can only be one feedback for a session. However it is possible that the attending therapist ask the client to repeat the same session. In this case for the same content id there will be a second session in the same module, where the therapist can as well provide a new feedback.

  • The module title will by default be the title of the template it was created from, but can be changed by the therapist.

  • Module sessions export includes only the modules created from a template.

Screening questionnaires

Name

Value

Explanation

Value type

Notes

Users

client database id

Client/friend database ID

Internal database identifier of the client or friend.

Text

default
professional database id

Professional database ID

Internal database identifier for the professional.

Text

default

General

id

Questionnaire ID

Database identifier for this screening questionnaire.

Text

default
screening id

Screening ID

Database identifier for the screening that the questionnaire is in.

Text

default
screening title

Screening title

Title for the screening that the questionnaire is in.

Text

default, private

Content

content

Content

Content document on which this screening questionnaire is based.

Object

default
template

Template

Content template that this screening questionnaire is in.

Object

default

Answers

answers

Answers

Answers to the questions.

List of object

default
computation results

Computation results

Computation results for the provided answers.

List of object

default

Lifecycle

creation

Creation

Date and time when this screening questionnaire was created.

Date and time

default
completion

Completion

Date and time when this screening questionnaire was completed.

Date and time

default
state

State

Snapshots of the state changes of the screening questionnaire.

List of object

default

Other

labels

Labels

Labels applied to this screening questionnaire.

List of text

This export is identified by the name: screening questionnaire.

The object content contains:

Name

Value

Explanation

Value type

Notes

id

Content identifier

-

Text

default
title

Content title

-

Text

default
version

Content version

-

Integer

default

The object template contains:

Name

Value

Explanation

Value type

Notes

id

Content identifier

-

Text

default
title

Content title

-

Text

default
version

Content version

-

Integer

default

The list of object state contains:

Name

Value

Explanation

Value type

Notes

change

Changed value

New state after the change.

Text

default
changed when

When

When did the change happen.

Date and time

default

The list of object answers contains:

Name

Value

Explanation

Value type

Notes

key

Question identifier

-

Text

default
value

Answer given

-

JSON data

default, private

The list of object computation results contains:

Name

Value

Explanation

Value type

Notes

key

Computation identifier

-

Text

default
value

Computed value

-

JSON data

default, private

Remarks

  • A questionnaire is created with the same identifier as its content.

  • Unlike other tools, questionnaires are created only when the client starts them and not when a professional assigns them to the client.

  • It is not possible to add, remove or reorganize questionnaires in a screening.

  • The screening title will by default be the title of the template, but can be changed by the therapist.

Training sessions

Name

Value

Explanation

Value type

Notes

Users

client database id

Client/friend database ID

Internal database identifier of the client or friend.

Text

default
professional database id

Professional database ID

Internal database identifier for the professional.

Text

default

General

id

Session ID

Database identifier for this training.

Text

default
training id

Training ID

Database identifier for the training that the session is in.

Text

default
training title

Training title

Title for the training that the session is in.

Text

default, private

Content

content

Content

Content document that this training consists of.

Object

default
template

Template

Content template that this training is in.

Object

Answers

answers

Answers

Answers to the questions.

List of object

default
computation results

Computation results

Computation results for the provided answers.

List of object

default

Lifecycle

creation

Creation

Date and time when this training was created.

Date and time

default
start date

Start date

Date when this was scheduled to start.

Date and time

default
completion

Completion

Date and time when this training was completed.

Date and time

default
state

State

Snapshots of the state changes of the training.

List of object

default

Other

labels

Labels

Labels applied to this training.

List of text

This export is identified by the name: training session.

The object content contains:

Name

Value

Explanation

Value type

Notes

id

Content identifier

-

Text

default
title

Content title

-

Text

default
version

Content version

-

Integer

default

The object template contains:

Name

Value

Explanation

Value type

Notes

id

Content identifier

-

Text

default
title

Content title

-

Text

default
version

Content version

-

Integer

default

The list of object state contains:

Name

Value

Explanation

Value type

Notes

change

Changed value

New state after the change.

Text

default
changed when

When

When did the change happen.

Date and time

default

The list of object answers contains:

Name

Value

Explanation

Value type

Notes

key

Question identifier

-

Text

default
value

Answer given

-

JSON data

default, private

The list of object computation results contains:

Name

Value

Explanation

Value type

Notes

key

Computation identifier

-

Text

default
value

Computed value

-

JSON data

default, private

Remarks

  • It is not possible to add, remove or reorganize sessions in a training.

  • The training title will by default be the title of the template, but can be changed by the therapist.

Monitoring entries

Name

Value

Explanation

Value type

Notes

Users

client database id

Client/friend database ID

Internal database identifier of the client or friend.

Text

default
professional database id

Professional database ID

Internal database identifier for the professional.

Text

default

General

id

Entry ID

Database identifier for this monitoring entry.

Text

default
monitoring id

Monitoring ID

Database identifier for the monitoring that the entry is in.

Text

default
monitoring title

Monitoring title

Title for the monitoring that the entry is in.

Text

default, private
reason non response

Reason for non response

The reason that the user has not responded.

Text

default

Details

template

Template

Content template that this monitoring entry is in.

Object

default
document

Documents

Documents associated with the monitoring entry.

List of object

Lifecycle

creation

Creation

Date and time when this monitoring entry was created.

Date and time

default
due

Due date

Date when the monitoring entry was scheduled to be filled in.

Date

completion

Completion

Date and time when this monitoring entry was completed.

Date and time

default
state

State

Snapshots of the state changes of the monitoring entry.

List of object

default

Other

labels

Labels

Labels applied to this monitoring entry.

List of text

This export is identified by the name: monitoring entry.

The object template contains:

Name

Value

Explanation

Value type

Notes

id

Content identifier

-

Text

default
title

Content title

-

Text

default
version

Content version

-

Integer

default

The list of object state contains:

Name

Value

Explanation

Value type

Notes

change

Changed value

New state after the change.

Text

default
changed when

When

When did the change happen.

Date and time

default

The list of object document contains:

Name

Value

Explanation

Value type

Notes

content

Content

Content document that this monitoring entry consists of.

Object

default
answers

Answers

Answers to the questions.

List of object

default
computation results

Computation results

Computation results for the provided answers.

List of object

default

The object content contains:

Name

Value

Explanation

Value type

Notes

id

Content identifier

-

Text

default
title

Content title

-

Text

default
version

Content version

-

Integer

default

The list of object answers contains:

Name

Value

Explanation

Value type

Notes

key

Question identifier

-

Text

default
value

Answer given

-

JSON data

default, private

The list of object computation results contains:

Name

Value

Explanation

Value type

Notes

key

Computation identifier

-

Text

default
value

Computed value

-

JSON data

default, private

Remarks

  • It is possible to remove an entry from a monitoring if it is not due yet.

  • It is possible to add additional entries to a monitoring if they are scheduled in the future.

  • It is possible to have multiple entries due at the same date.

  • The monitoring title will by default be the title of the template, but can be changed by the therapist.

Action plans

Name

Value

Explanation

Value type

Notes

Users

client database id

Client/friend database ID

Internal database identifier of the client or friend.

Text

default
professional database id

Professional database ID

Internal database identifier for the professional.

Text

default

General

id

Action plan ID

Database identifier for this action plan.

Text

default
plan title

Plan title

Title assigned to this action plan.

Text

default, private
goal

Goal

Action plan goal definition

Object

default

Answers

evaluations

Evaluations

The user self-reported evaluation that tracks the progress towards achieving the goal.

List of object

default

Lifecycle

creation

Creation

Date and time when this action plan was created.

Date and time

default
completion

Completion

Date and time when this action plan was completed.

Date and time

default
state

State

Snapshots of the state changes of the action plan.

List of object

default

Other

labels

Labels

Labels applied to this action plan.

List of text

This export is identified by the name: action plan.

The object goal contains:

Name

Value

Explanation

Value type

Notes

description

Description

Goal description

Text

default, private
end date

End date

Targetted end date for goal

Date

default
progress

Progress

Progress towards achieving the goal

Integer

default

The list of object evaluation contains:

Name

Value

Explanation

Value type

Notes

id

Database identifier

-

Text

default
creation date

Creation date

-

Date

default
progress

Progress

Progress for this evaluation

Integer

default
remark

Remark

Optional remark for evaluation

Text

default, private

The list of object state contains:

Name

Value

Explanation

Value type

Notes

change

Changed value

New state after the change.

Text

default
changed when

When

When did the change happen.

Date and time

default

Motivation plans

Name

Value

Explanation

Value type

Notes

Users

client database id

Client/friend database ID

Internal database identifier of the client or friend.

Text

default
professional database id

Professional database ID

Internal database identifier for the professional.

Text

default

General

id

Plan ID

Database identifier for this motivation plan.

Text

default
title

Plan title

Title for this plan.

Text

default, private

Answers

miracle question

Miracle question

Miracle question for this plan.

Text

default, private
image

Image

The image uploaded for this motivation plan.

File

private, file
goal

Goals

List of goals defined for this motivation plan.

List of object

default

Lifecycle

creation

Creation

Date and time when this motivation plan was created.

Date and time

default

Other

labels

Labels

Labels applied to this motivation plan.

List of text

This export is identified by the name: motivation plan.

The list of object goal contains:

Name

Value

Explanation

Value type

Notes

id

Database identifier

-

Text

default
definition

Definition

-

Text

default, private
description

Description

-

Text

default, private
done

Done

Is the goal done?

Boolean

default
action

Undocumented property

-

List of object

default

The list of object action contains:

Name

Value

Explanation

Value type

Notes

id

Database identifier

-

Text

default
definition

Definition

-

Text

default, private
description

Description

-

Text

default, private
done

Done

Is the action done?

Boolean

default

Remarks

  • Motivation plans is a legacy feature which is going to be replaced in a near future.

Practice plans

Name

Value

Explanation

Value type

Notes

Users

client database id

Client/friend database ID

Internal database identifier of the client or friend.

Text

default
professional database id

Professional database ID

Internal database identifier for the professional.

Text

default

General

id

Plan ID

Database identifier for this practice plan.

Text

default
title

Plan title

Title for this plan.

Text

default, private

Answers

image

Image

The image uploaded for this plan.

File

private, file
situation 10

Situation 10

The situation 10 defined for this plan.

Text

default, private
situation 20

Situation 20

The situation 20 defined for this plan.

Text

default, private
situation 30

Situation 30

The situation 30 defined for this plan.

Text

default, private
situation 40

Situation 40

The situation 40 defined for this plan.

Text

default, private
situation 50

Situation 50

The situation 50 defined for this plan.

Text

default, private
situation 60

Situation 60

The situation 60 defined for this plan.

Text

default, private
situation 70

Situation 70

The situation 70 defined for this plan.

Text

default, private
situation 80

Situation 80

The situation 80 defined for this plan.

Text

default, private
situation 90

Situation 90

The situation 90 defined for this plan.

Text

default, private
situation 100

Situation 100

The situation 100 defined for this plan.

Text

default, private
evaluations

Evaluations

The evaluations defined for this plan.

List of object

default

Lifecycle

creation

Creation

Date and time when this practice plan was created.

Date and time

default

Other

labels

Labels

Labels applied to this practice plan.

List of text

This export is identified by the name: practice plan.

The list of object evaluation contains:

Name

Value

Explanation

Value type

Notes

id

Database identifier

-

Text

default
date

Date

-

Date

default
evaluation

Undocumented property

-

Text

default, private

Remarks

  • Practice plans is a legacy feature which is going to be replaced in a near future.

Relapse prevention plans

Name

Value

Explanation

Value type

Notes

Users

client database id

Client/friend database ID

Internal database identifier of the client or friend.

Text

default
professional database id

Professional database ID

Internal database identifier for the professional.

Text

default

General

id

Plan ID

Database identifier for this relapse prevention plan.

Text

default
title

Plan title

Title for this plan.

Text

default, private

Answers

trigger

Triggers

The relapse triggers.

Text

default, private
actions

Actions

The actions for those triggers.

Text

default, private
early_signs_stage1

Early signs stage 1

The early signs for stage 1 of relapse.

Text

default, private
actions_stage1

Actions stage 1

The actions to take to stay in stage 1 of relapse.

Text

default, private
early_signs_stage2

Early signs stage 2

The early signs for stage 2 of relapse.

Text

default, private
actions_stage2

Actions stage 2

The actions to take in stage 2 of relapse.

Text

default, private
early_signs_stage3

Early signs stage 3

The early signs for stage 3 of relapse.

Text

default, private
actions_stage3

Actions stage 3

The actions to take in stage 3 of relapse.

Text

default, private
early_signs_stage4

Early signs stage 4

The early signs for stage 4 of relapse.

Text

default, private
actions_stage4

Actions stage 4

The actions to take in stage 4 of relapse.

Text

default, private

Lifecycle

creation

Creation

Date and time when this relapse prevention plan was created.

Date and time

default

Other

labels

Labels

Labels applied to this relapse prevention plan.

List of text

This export is identified by the name: relapse prevention plan.

Remarks

  • Relapse prevention plans is a legacy feature which is going to be replaced in a near future.