Goal data model
View field support, webhooks, and list parameters for each integration on the Supported Integrations page.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier for the goal |
created_at | string (date-time) | No | When the goal record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | When the goal record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
patient_id | string | No | The patient the goal is for |
practitioner_id | string | No | The practitioner who set the goal |
condition_ids | string[] | No | Conditions the goal addresses |
name | string | No | Human-readable description of the goal |
codes | HealthcareCode[] | No | Codings for the goal |
codes[].system | string | No | The code system URI (e.g. http://loinc.org, http://snomed.info/sct) |
codes[].code | string | No | The code within the system |
codes[].display | string | No | Human-readable display text for the code |
status | enum | No | Lifecycle status of the goal Values: PROPOSED, PLANNED, ACCEPTED, ACTIVE, ON_HOLD, COMPLETED, CANCELLED, ENTERED_IN_ERROR, REJECTED, OTHER |
achievement_status | enum | No | Progress towards the goal Values: IN_PROGRESS, IMPROVING, WORSENING, NO_CHANGE, ACHIEVED, SUSTAINING, NOT_ACHIEVED, NO_PROGRESS, NOT_ATTAINABLE, OTHER |
start_at | string (date-time) | No | When work on the goal starts (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
due_at | string (date-time) | No | When the goal should be reached (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
notes | string | No | Free-text notes about the goal |
metadata | HealthcareMetadata[] | No | Custom field values |
metadata[].id | string | No | Identifier of the custom field |
metadata[].value | object | No | The custom field value |
metadata[].namespace | string | No | The scope or origin of the custom field |
metadata[].format | enum | No | The data type of the value Values: TEXT, NUMBER, DATE, BOOLEAN, ARRAY, OBJECT |
metadata[].extra_data | object | No | Additional data about the custom field |
metadata[].slug | string | No | The custom field key |
Are we missing anything? Let us know