Skip to main content
You are here: Data Exports

Data Export - Goal

Generated by the Bulk Data Export system.

The order of columns is subject to change. When parsing files, please ensure to use headers rather than positional parsing to ensure you are reading the data correctly.

Column

Name

Format

Cardinality

Notes

instituteId

Institute Id

identifier

1..*

Unique identifier of the institute

instituteShortcode

Institute Shortcode

string

1..*

Short string human-readable name of the institute found in the institute
URL

id

Id

identifier

1..1

status

Status

string

1..1

new โ€” the goal has been created but the patient hasn't answered it yet. It starts here and transitions to active once the first answer is recorded.

active โ€” the patient has answered the goal at least once. This is the normal "in progress" state for a live goal.

paused โ€” the goal was active but has been temporarily paused (e.g. deprioritized). It can be resumed back to active, completed, or canceled from this state.

goalType

Goal Type

string

1..1

isBeneficial

Is Beneficial

true/false

1..1

The higher scores, the better

startDate

Start Date

timestamp

1..1

endDate

End Date

timestamp

0..1

episodeOfCare

Episode Of Care Id

identifier

1..1

userId

User Id

identifier

1..1