Goal REST Endpoints

Sort by

Task Path Method

Description

Goal

This topic describes information for the Goal resource.

Overview

Note:

The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

The Goal resource describes intended objectives for a patient. A goal is typically expressed as a desired outcome or health state to be achieved by a patient over a period or at a specific point in time. A goal may address preventative health or mitigation of a diagnosis or problem. Goals can be non-healthcare related (for example, dance at a wedding).

Profile Support

This resource supports the US Core Goal Profile from the HL7 FHIR US Core Implementation Guide STU 6.1.0.

Note:

The examples provided here are nonnormative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.

Returned Fields

Element	Type
Goal	DomainResource
Goal.lifecycleStatus	code
Goal.description	CodeableConcept
Goal.subject	Reference Patient Organization
Goal.start[x]	date CodeableConcept
Goal.target	BackboneElement
Goal.due[x]	date / Duration

Terminology Bindings

Element	Description	Details
Goal.lifecycleStatus	The state of the goal throughout its lifecycle.	System
Goal.description	The description (human-readable, coded, or both) of a specific desired objective of care, such as control blood pressure, negotiate an obstacle course, or dance with child at wedding.	SNOMED CT
Goal.start[x]	The date or event after which the goal should begin being pursued.	System

Goal

The operations from the Goal category.

Get a goal by ID

Method: get

Path: /Goal/{id}

Get a list of goals

Method: get

Path: /Goal