Goal - FHIR Resource (dstu2)


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

Validate an Goal FHIR Resource (dstu2)



Resource Attributes

AttributeField is listTypeDescription
addressestrueReference# "addresses" : [{ Reference(Condition|Observation|MedicationStatement|
authorfalseReference# Who's responsible for creating Goal?
categorytrueCodeableConcept# E.g. Treatment, dietary, behavioral, etc.
descriptionfalsestring# What's the desired outcome?
identifiertrueIdentifier# External Ids for this goal
notetrueAnnotation# Comments about the goal
outcometrueData Type# What was end result of goal?
priorityfalseCodeableConcept# high | medium |low
startCodeableConceptfalseCodeableConcept# "startCodeableConcept" : { CodeableConcept },
startDatefalsedate# "startDate" : "<date>",
statusfalsecode# proposed | planned | accepted | rejected | in-progress | achieved | sustaining | on-hold | cancelled
statusDatefalsedate# When goal status took effect
statusReasonfalseCodeableConcept# Reason for current status
subjectfalseReference# Who this goal is intended for
targetDatefalsedate# "targetDate" : "<date>",
targetQuantityfalseQuantity# "targetQuantity" : { Quantity(Duration) },

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
  "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[x]: Reach goal on or before. One of these 2:
  "targetDate" : "<date>",
  "targetQuantity" : { Quantity(Duration) },
  "category" : [{ CodeableConcept }], // E.g. Treatment, dietary, behavioral, etc.
  "description" : "<string>", // R!  What's the desired outcome?
  "status" : "<code>", // R!  proposed | planned | accepted | rejected | in-progress | achieved | sustaining | on-hold | cancelled
  "statusDate" : "<date>", // When goal status took effect
  "statusReason" : { CodeableConcept }, // Reason for current status
  "author" : { Reference(Patient|Practitioner|RelatedPerson) }, // Who's responsible for creating Goal?
  "priority" : { CodeableConcept }, // high | medium |low
  "addresses" : [{ Reference(Condition|Observation|MedicationStatement|
   NutritionOrder|ProcedureRequest|RiskAssessment) }], // Issues addressed by this goal
  "note" : [{ Annotation }], // Comments about the goal
  "outcome" : [{ // What was end result of goal?
    // result[x]: Code or observation that resulted from goal. One of these 2:
    "resultCodeableConcept" : { CodeableConcept }
    "resultReference" : { Reference(Observation) }
  }]
}


 

Goal Search Parameters

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

https://api.1up.health/fhir/dstu2/Goal?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
categorytextcategory
identifiertextidentifier
patientreferencesubject
statustextstatus
subjectreferencesubject
targetdatedatetargetDate