Goal - FHIR Resource (dstu2)
This Goal Resource uses the
FHIR API standard for access and structure.
Resource Attributes
Attribute | Field is list | Type | Description |
---|
addresses | true | Reference | "addresses" : [{ Reference(Condition|Observation|MedicationStatement|
|
author | false | Reference | Who's responsible for creating Goal?
|
category | true | CodeableConcept | E.g. Treatment, dietary, behavioral, etc.
|
description | false | string | What's the desired outcome?
|
identifier | true | Identifier | External Ids for this goal
|
note | true | Annotation | Comments about the goal
|
outcome | true | Data Type | What was end result of goal?
|
priority | false | CodeableConcept | high | medium |low
|
startCodeableConcept | false | CodeableConcept | "startCodeableConcept" : { CodeableConcept },
|
startDate | false | date | "startDate" : "<date>",
|
status | false | code | proposed | planned | accepted | rejected | in-progress | achieved | sustaining | on-hold | cancelled
|
statusDate | false | date | When goal status took effect
|
statusReason | false | CodeableConcept | Reason for current status
|
subject | false | Reference | Who this goal is intended for
|
targetDate | false | date | "targetDate" : "<date>",
|
targetQuantity | false | Quantity | "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 Parameter | Field Type | Resource Fields Searched |
---|
category | text | category |
identifier | text | identifier |
patient | reference | subject |
status | text | status |
subject | reference | subject |
targetdate | date | targetDate |