Skip to main content

Data Export - Patient 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.

What this export contains​

One row per patient goal set during treatment, with its type, whether a higher value is beneficial, its date range and the episode and user it belongs to. Pair it with Goal Answer to see the progress recorded against each goal.

Example questions this export can answer​

  • See how many patients have goals set and of what types
  • Track goal-setting activity by provider or program
  • Join to Goal Answer to measure goal progress over time
ColumnNameFormatCardinalityNotes
instituteIdInstitute Ididentifier1..*Unique identifier of the institute
instituteShortcodeInstitute Shortcodestring1..*Short string human-readable name of the institute found in the instituteURL
idIdidentifier1..1
statusStatusstring1..1new — 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.
goalTypeGoal Typestring1..1
isBeneficialIs Beneficialtrue/false1..1The higher scores, the better
startDateStart Datetimestamp1..1
endDateEnd Datetimestamp0..1
episodeOfCareEpisode Of Care Ididentifier1..1
userIdUser Ididentifier1..1