Goal - FHIR Resource (r4)


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

Validate an Goal FHIR Resource (r4)



Resource Attributes

AttributeField is listTypeDescription
achievementStatusfalseCodeableConcept# in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable
addressestrueReference# "addresses" : [{ Reference(Condition|Observation|MedicationStatement|
categorytrueCodeableConcept# E.g. Treatment, dietary, behavioral, etc.
descriptionfalseCodeableConcept# Code or text describing goal
expressedByfalseReference# "expressedBy" : { Reference(Patient|Practitioner|PractitionerRole|
identifiertrueIdentifier# External Ids for this goal
lifecycleStatusfalsecode# proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected
notetrueAnnotation# Comments about the goal
outcomeCodetrueCodeableConcept# What result was achieved regarding the goal?
outcomeReferencetrueReference# Observation that resulted from goal
priorityfalseCodeableConcept# high-priority | medium-priority | low-priority
start[x]falsedate|CodeableConcept#undefined
statusDatefalsedate# When goal status took effect
statusReasonfalsestring# Reason for current status
subjectfalseReference# Who this goal is intended for
targettrueData Type# C? Target outcome for the goal

Goal 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"
    }
  ]
}

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
  "lifecycleStatus" : "<code>", // R!  proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected
  "achievementStatus" : { CodeableConcept }, // in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable
  "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) }, // R!  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 7:
    "detailQuantity" : { Quantity },
    "detailRange" : { Range },
    "detailCodeableConcept" : { CodeableConcept },
    "detailString" : "<string>",
    "detailBoolean" : <boolean>,
    "detailInteger" : <integer>,
    "detailRatio" : { Ratio },
    // 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|PractitionerRole|
   RelatedPerson) }, // Who's responsible for creating Goal?
  "addresses" : [{ Reference(Condition|Observation|MedicationStatement|
   NutritionOrder|ServiceRequest|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/r4/Goal?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
achievement-statustextachievementStatus
categorytextcategory
identifiertextidentifier
lifecycle-statustextlifecycleStatus
patientreferencesubject.where
start-datedatestart
subjectreferencesubject
target-datedatetarget.due