Goal

ResourceClinical · Care ProvisionTrial useMaturity 2

Describes the intended objective(s) for a patient, group or organization care, for example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc.

StructureSearch parametersHL7 specificationStructureDefinition JSON

Tested supportFull test results →

Backends

PostgreSQLElasticsearch

Interactions

CreateReadUpdatePatchDelete

Search

8 of 8 parameters tested

Structure

Show inherited elements (11)

Element	Card.	Type	Description
identifier	0..*	Identifier	External Ids for this goal
lifecycleStatusRequired?!Σ	1..1	code	proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejectedBinding (required): goal-status
achievementStatusΣ	0..1	CodeableConcept	in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainableBinding (preferred): goal-achievement
categoryΣ	0..*	CodeableConcept	E.g. Treatment, dietary, behavioral, etc.Binding (example): goal-category
priorityΣ	0..1	CodeableConcept	high-priority | medium-priority | low-priorityBinding (preferred): goal-priority
descriptionRequiredΣ	1..1	CodeableConcept	Code or text describing goalBinding (example): clinical-findings
subjectRequiredΣ	1..1	Reference(Patient | Group | Organization)	Who this goal is intended for
start[x]Σ	0..1	date | CodeableConcept	When goal pursuit beginsBinding (example): goal-start-event
target	0..*	BackboneElement	Target outcome for the goal
measureΣ	0..1	CodeableConcept	The parameter whose value is being trackedBinding (example): observation-codes
detail[x]Σ	0..1	Quantity | Range | CodeableConcept | string | boolean | integer | Ratio	The target value to be achieved
due[x]Σ	0..1	date | Duration	Reach goal on or before
statusDateΣ	0..1	date	When goal status took effect
statusReason	0..1	string	Reason for current status
expressedByΣ	0..1	Reference(Patient | Practitioner | PractitionerRole | RelatedPerson)	Who's responsible for creating Goal?
addresses	0..*	Reference(Condition | Observation | MedicationStatement | NutritionOrder | ServiceRequest | RiskAssessment)	Issues addressed by this goal
note	0..*	Annotation	Comments about the goal
outcomeCode	0..*	CodeableConcept	What result was achieved regarding the goal?Binding (example): clinical-findings
outcomeReference	0..*	Reference(Observation)	Observation that resulted from goal

Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey

Search parameters

Query with GET [base]/Goal?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.

Parameter	Type	Description	PG	ES
achievement-status	token	in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable Goal.achievementStatus
category	token	E.g. Treatment, dietary, behavioral, etc. Goal.category
identifier	token	External Ids for this goal Goal.identifier
lifecycle-status	token	proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected Goal.lifecycleStatus
patient	reference	Who this goal is intended for Goal.subject.where(resolve() is Patient)
start-date	date	When goal pursuit begins (Goal.start.ofType(date))
subject	reference	Who this goal is intended for Goal.subject
target-date	date	Reach goal on or before (Goal.target.due.ofType(date))

PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet.

Common parameters on every resource (8)

_haste-health-author	reference	The author of the resource
_id	token	Logical id of this artifact
_lastUpdated	date	When the resource version last changed
_profile	uri	Profiles this resource claims to conform to
_security	token	Security Labels applied to this resource
_source	uri	Identifies where the resource comes from
_tag	token	Tags applied to this resource
_type	token	Derived from the R4B Definition