Interface / 4.0.1 (R4) / Goal

Goal

A Goal resource is used to document the objectives related to a patient’s care.

Overview

See the FHIR documentation for more information about Goal resources.

Goal resources support the following interactions.

When searching for Goal resources, the following search parameters are supported.

Name	Type	Prefixes Modifiers	Can be Chained?	Description
_count	Special			The maximum number of resources to return in a result page.
_elements	Special			Used to request a specific set of elements be returned as part of a resource.
_id	Token			Resource id.
_lastUpdated	Date	ne lt le gt ge sa eb ap		When the resource last changed.
_source	Uri	:missing		Where the resource comes from.
_summary	Special			Used to return only a portion of the resouces. Defaults to 'false', which returns the whole resource.
_total	Special			Use the value 'estimate' to populate the result bundle's 'total' element with an estimate of the matching number of resources.
category	Token	:not :in :notin :missing		E.g. Treatment, dietary, behavioral, etc.
date	Date	ne lt le gt ge sa eb ap :missing		Search by due date.
lifecycle-status	Token	:not :in :notin :missing		proposed \| planned \| accepted \| active \| on-hold \| completed \| cancelled \| entered-in-error \| rejected.
patient	Reference	:missing	yes	The patient the Goal is about.
provenance-agent	Reference	:missing	yes	Search by provenance, specified by its author (aka originator) Organization.
start-date	Date	ne lt le gt ge sa eb ap :missing		When goal pursuit begins.
subject	Reference	:missing	yes	The patient the Goal is about. Functionally identical to the "patient" search parameter.
target-date	Date	ne lt le gt ge sa eb ap :missing		Reach goal on or before.

When searching Goal resources, it is possible to sort the returned values by the following search parameters.

Only one sort parameter may be specified.

When searching Goal resources, it is possible to include the resources referenced by the following field names.