Goal

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.

Response Description

Sample Response

{

  "resourceType": "Goal",

  "id": "DEV-DEV-11913-616",

  "meta": {

     "lastUpdated": "2022-11-14T12:00:00-05:00",

     "profile": [

        "http://hl7.org/fhir/us/core/StructureDefinition/us-core-goal"

     ]

  },

  "text": {

     "status": "generated",

     "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><table><tbody><tr><td>Patient:</td><td>Cole Andersonian, Sr. (DEV-DEV-11913)</td></tr><tr><td>Encounter:</td><td>DEV-DEV-11913-0014796</td></tr><tr><td>Goal:</td><td>A simple care goal for this patient to stop smoking. Suggestion: The day before your quit day, throw away all ashtrays and lighters. Do not just hide them because you will find them. Get rid of all leftover tobacco products by flushing them down the toilet. Take the lighter out of your car.</td></tr><tr><td>Date:</td><td>11/14/22</td></tr></tbody></table></div>"

  },

  "lifecycleStatus": "planned",

  "description": {

     "text": "A simple care goal for this patient to stop smoking. Suggestion: The day before your quit day, throw away all ashtrays and lighters. Do not just hide them because you will find them. Get rid of all leftover tobacco products by flushing them down the toilet. Take the lighter out of your car."

  },

  "target": [

     {

        "dueDate": "2023-02-12"

     }

  ],

  "subject": {

     "reference": "Patient/DEV-DEV-11913",

     "display": "Cole Andersonian, Sr. (DEV-DEV-11913)"

  }

}

Goal.id

The internal id of the goal. Once assigned, this value never changes.

Goal.meta

Metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Goal.text

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative.

Goal.lifecycleStatus

The state of the goal throughout its lifecycle.

Goal.description

Human-readable and/or coded description of a specific desired objective of care.

Goal.target

Indicates what should be done by when.

Goal.target.dueDate

Indicates either the date or the duration after start by which the goal should be met.

Goal.subject

Identifies the patient, group or organization for whom the goal is being established.

Search

URL Syntax

Two HTTP methods are supported for searching: GET and POST. It is recommended to use HTTP POST.

Visit the FHIR Sandbox to try requests.

HTTP GET - searching

https://sandbox.pai.healthcare/preview/fhir/Goal?{query string}

HTTP GET - return single record

https://sandbox.pai.healthcare/preview/fhir/Goal/{resource id}

HTTP POST - searching

https://sandbox.pai.healthcare/preview/fhir/Goal/_search

•Set the Content-Type header to application/x-www-urlencoded

•The body of the request is a similar query string used in the GET type of request detailed above.

Error Handling

If no records are returned or invalid search parameters are provided, then an HTTP 400 Bad Request is returned.

The body of the response will be an OperationOutcome.

Supported Search Parameters

_id

patient

encounter