Skip to main content

R4 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:

Operations​

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

CareRecord / SolutionCreateReadUpdateSearch
GEHRIMED-Yes-Yes
myAvatar-Yes-Yes
myEvolv-Yes-Yes
myUnity-Yes-Yes
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​

NameTypeDescription
patientreferenceREQUIRED Who this goal is intended for
lifecycle-statustokenproposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected
target-datedateReach goal on or before

Search Example​

Via POST​

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

Search by Patient and Target Date
curl -X POST https://fhir.netsmartcloud.com/v4/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​
Search by Patient and Target Date
curl -X GET "https://fhir.netsmartcloud.com/v4/Goal?patient=Patient/123&target-date=ge2023-07-10" \
    -H "Authorization: {Bearer Token}" \
    -H "Accept: application/fhir+json"