Goal

The Goal resource "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." (HL7 FHIR R4 Goal)

Supported Profiles

This API supports the following FHIR profiles:

• HL7 FHIR R4 Goal
• US Core Goal

Operations

The Certified API Goal resource supports the following standard operations. However, support varies by the targeted CareRecord or solution.

CareRecord / Solution	Create	Read	Update	Search
GEHRIMED	-	Yes	-	Yes
myAvatar	-	Yes	-	Yes
myEvolv	-	Yes	-	Yes
myUnity	-	Yes	-	Yes
TheraOffice	-	Yes	-	Yes

Search

info

Not all Netsmart solutions support Goal search. See supported operations table above and consult your target solution's documentation for more information.

This operation retrieves a list of resources by these query parameters.

Search Parameters

Name	Type	Description
patient	reference	REQUIRED Who this goal is intended for
lifecycle-status	token	proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected
page	string	Zero-based page index
start-date	date	When goal pursuit begins
target-date	date	Reach goal on or before
_revinclude	special	Include Provenance resource(s) that reference the matched search results. Allowed: "Provenance:target"

Search Example

Via POST

The POST method is recommended as it keeps health information out of the URL.

Production

Search by Patient and Target Date

curl -X POST https://fhir.netsmartcloud.com/uscore/v1/Goal/_search \
    -H "Authorization: {Bearer Token}" \
    -H "Accept: application/fhir+json" \
    -H "Content-Type: application/x-form-urlencoded" \
    -d "patient=Patient/123" \
    -d "target-date=ge2023-07-10"

Preview

Search by Patient and Target Date

curl -X POST https://fhirtest.netsmartcloud.com/uscore/v1/Goal/_search \
    -H "Authorization: {Bearer Token}" \
    -H "Accept: application/fhir+json" \
    -H "Content-Type: application/x-form-urlencoded" \
    -d "patient=Patient/123" \
    -d "target-date=ge2023-07-10"

Via GET

Production

Search by Patient and Target Date

curl -X GET "https://fhir.netsmartcloud.com/uscore/v1/Goal?patient=Patient/123&target-date=ge2023-07-10" \
    -H "Authorization: {Bearer Token}" \
    -H "Accept: application/fhir+json"

Preview

Search by Patient and Target Date

curl -X GET "https://fhirtest.netsmartcloud.com/uscore/v1/Goal?patient=Patient/123&target-date=ge2023-07-10" \
    -H "Authorization: {Bearer Token}" \
    -H "Accept: application/fhir+json"