Goal - FHIR Resource (stu3)


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

Resource Attributes

AttributeField is listTypeDescription
addressestrueReference "addresses" : [{ Reference(Condition|Observation|MedicationStatement|
categorytrueCodeableConcept E.g. Treatment, dietary, behavioral, etc.
descriptionfalseCodeableConcept Code or text describing goal
expressedByfalseReference Who's responsible for creating Goal?
identifiertrueIdentifier External Ids for this goal
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
startCodeableConceptfalseCodeableConcept "startCodeableConcept" : { CodeableConcept },
startDatefalsedate "startDate" : "<date>",
statusfalsecode proposed | accepted | planned | in-progress | on-target | ahead-of-target | behind-target | sustaining | achieved | on-hold | cancelled | entered-in-error | rejected
statusDatefalsedate When goal status took effect
statusReasonfalsestring Reason for current status
subjectfalseReference Who this goal is intended for
targetfalseData 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 the like so:

https://api.1up.health/fhir/stu3/Goal?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
categorytextcategory
identifiertextidentifier
patientreferencesubject
start-datedatestart.as
statustextstatus
subjectreferencesubject
target-datedatetarget.due.as