Goal - FHIR Resource (stu3)

This Goal Resource uses the FHIR API standard for access and structure.

Validate an Goal FHIR Resource (stu3)

Validate this Goal

Resource Attributes

Attribute	Field is list	Type	Description
addresses	true	Reference	# "addresses" : [{ Reference(Condition|Observation|MedicationStatement|
category	true	CodeableConcept	# E.g. Treatment, dietary, behavioral, etc.
description	false	CodeableConcept	# Code or text describing goal
expressedBy	false	Reference	# Who's responsible for creating Goal?
identifier	true	Identifier	# External Ids for this goal
note	true	Annotation	# Comments about the goal
outcomeCode	true	CodeableConcept	# What result was achieved regarding the goal?
outcomeReference	true	Reference	# Observation that resulted from goal
priority	false	CodeableConcept	# high-priority | medium-priority | low-priority
startCodeableConcept	false	CodeableConcept	# "startCodeableConcept" : { CodeableConcept },
startDate	false	date	# "startDate" : "<date>",
status	false	code	# proposed | accepted | planned | in-progress | on-target | ahead-of-target | behind-target | sustaining | achieved | on-hold | cancelled | entered-in-error | rejected
statusDate	false	date	# When goal status took effect
statusReason	false	string	# Reason for current status
subject	false	Reference	# Who this goal is intended for
target	false	Data Type	# C? Target outcome for the goal

Goal Example

{
  "status": "on-hold",
  "category": [
    {
      "coding": [
        {
          "code": "dietary",
          "system": "http://hl7.org/fhir/goal-category"
        }
      ]
    }
  ],
  "outcomeReference": [
    {
      "display": "Body Weight Measured",
      "reference": "Observation/example"
    }
  ],
  "addresses": [
    {
      "display": "obesity condition"
    }
  ],
  "description": {
    "text": "Target weight is 160 to 180 lbs."
  },
  "startDate": "2015-04-05",
  "resourceType": "Goal",
  "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>"
  },
  "expressedBy": {
    "display": "Peter James Chalmers",
    "reference": "Patient/example"
  },
  "statusReason": "Patient wants to defer weight loss until after honeymoon.",
  "priority": {
    "text": "high",
    "coding": [
      {
        "code": "high-priority",
        "system": "http://hl7.org/fhir/goal-priority",
        "display": "High Priority"
      }
    ]
  },
  "target": {
    "detailRange": {
      "high": {
        "code": "[lb_av]",
        "unit": "lbs",
        "value": 180,
        "system": "http://unitsofmeasure.org"
      },
      "low": {
        "code": "[lb_av]",
        "unit": "lbs",
        "value": 160,
        "system": "http://unitsofmeasure.org"
      }
    },
    "dueDate": "2016-04-05",
    "measure": {
      "coding": [
        {
          "code": "3141-9",
          "system": "http://loinc.org",
          "display": "Weight Measured"
        }
      ]
    }
  },
  "statusDate": "2016-02-14",
  "identifier": [
    {
      "value": "123"
    }
  ],
  "id": "example",
  "subject": {
    "display": "Peter James Chalmers",
    "reference": "Patient/example"
  }
}

Goal Structure

  
{
  "resourceType" : "Goal",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // External Ids for this goal
  "status" : "<code>", // R!  proposed | accepted | planned | in-progress | on-target | ahead-of-target | behind-target | sustaining | achieved | on-hold | cancelled | entered-in-error | rejected
  "category" : [{ CodeableConcept }], // E.g. Treatment, dietary, behavioral, etc.
  "priority" : { CodeableConcept }, // high-priority | medium-priority | low-priority
  "description" : { CodeableConcept }, // R!  Code or text describing goal
  "subject" : { Reference(Patient|Group|Organization) }, // Who this goal is intended for
  // start[x]: When goal pursuit begins. One of these 2:
  "startDate" : "<date>",
  "startCodeableConcept" : { CodeableConcept },
  "target" : { // C? Target outcome for the goal
    "measure" : { CodeableConcept }, // C? The parameter whose value is being tracked
    // detail[x]: The target value to be achieved. One of these 3:
    "detailQuantity" : { Quantity },
    "detailRange" : { Range },
    "detailCodeableConcept" : { CodeableConcept },
    // due[x]: Reach goal on or before. One of these 2:
    "dueDate" : "<date>"
    "dueDuration" : { Duration }
  },
  "statusDate" : "<date>", // When goal status took effect
  "statusReason" : "<string>", // Reason for current status
  "expressedBy" : { Reference(Patient|Practitioner|RelatedPerson) }, // Who's responsible for creating Goal?
  "addresses" : [{ Reference(Condition|Observation|MedicationStatement|
   NutritionOrder|ProcedureRequest|RiskAssessment) }], // Issues addressed by this goal
  "note" : [{ Annotation }], // Comments about the goal
  "outcomeCode" : [{ CodeableConcept }], // What result was achieved regarding the goal?
  "outcomeReference" : [{ Reference(Observation) }] // Observation that resulted from goal
}


 

Goal Search Parameters

The following search parameters can be used to query Goal resources. Just submit them like so:

https://api.1up.health/fhir/stu3/Goal?query-param=queryvalue

Search Parameter	Field Type	Resource Fields Searched
category	text	category
identifier	text	identifier
patient	reference	subject
start-date	date	start.as
status	text	status
subject	reference	subject
target-date	date	target.due.as