API Reference

Update Goal with identifier {identifier}

Goal on the FHIR specification website.

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.

The body should be a valid FHIR object for Goal.

Here is an example:

{
  "resourceType": "Goal",
  "id": "example",
  "text": {
    "status": "additional",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n\t\t\t<p> A simple care goal for a patient to lose weight due to obesity.</p>\n\t\t</div>"
  },
  "identifier": [
    {
      "value": "123"
    }
  ],
  "lifecycleStatus": "on-hold",
  "category": [
    {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/goal-category",
          "code": "dietary"
        }
      ]
    }
  ],
  "priority": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/goal-priority",
        "code": "high-priority",
        "display": "High Priority"
      }
    ],
    "text": "high"
  },
  "description": {
    "text": "Target weight is 160 to 180 lbs."
  },
  "subject": {
    "reference": "Patient/example",
    "display": "Peter James Chalmers"
  },
  "startDate": "2015-04-05",
  "target": [
    {
      "measure": {
        "coding": [
          {
            "system": "http://loinc.org",
            "code": "3141-9",
            "display": "Weight Measured"
          }
        ]
      },
      "detailRange": {
        "low": {
          "value": 160,
          "unit": "lbs",
          "system": "http://unitsofmeasure.org",
          "code": "[lb_av]"
        },
        "high": {
          "value": 180,
          "unit": "lbs",
          "system": "http://unitsofmeasure.org",
          "code": "[lb_av]"
        }
      },
      "dueDate": "2016-04-05"
    }
  ],
  "statusDate": "2016-02-14",
  "statusReason": "Patient wants to defer weight loss until after honeymoon.",
  "expressedBy": {
    "reference": "Patient/example",
    "display": "Peter James Chalmers"
  },
  "addresses": [
    {
      "display": "obesity condition"
    }
  ],
  "outcomeReference": [
    {
      "reference": "Observation/example",
      "display": "Body Weight Measured"
    }
  ]
}

You can reference the FHIR documentation to determine the format for Goal.

Language
Credentials
Click Try It! to start a request and see the response here!