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.
Mapped Concepts in HIEBus
Supported Interactions
Goal resources support the following interactions.
Search Parameters
When searching for Goal resources, the following search parameters are supported.
Name |
Type
|
Prefixes
Modifiers
|
Can be Chained? |
Description |
_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.
|
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.
|
Sortable Parameters
When searching Goal resources, it is possible to sort the returned values by the following search parameters.
Only one sort parameter may be specified.
Supported Includes
When searching Goal resources, it is possible to include the resources referenced by the following field names.
- Patient
- Provenance Agent
- Subject
Back to Resources