Goal - FHIR Resource (dstu2)
This Goal Resource uses the FHIR API standard for access and structure.
Validate an Goal FHIR Resource (dstu2)
Goal Attributes
AttributeField is listTypeDescription
Description: E.g. Treatment, dietary, behavioral, etc.
FHIR Version: dstu2
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"category": Learn more about the (Goal) category FHIR attribute
Description: "startDate" : "<date>",
FHIR Version: dstu2
Attribute Type : date
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"startDate": Learn more about the (Goal) startDate FHIR attribute
Description: External Ids for this goal
FHIR Version: dstu2
Attribute Type : Identifier
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"identifier": Learn more about the (Goal) identifier FHIR attribute
Description: "addresses" : [{ Reference(Condition|Observation|MedicationStatement|
FHIR Version: dstu2
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"addresses": Learn more about the (Goal) addresses FHIR attribute
Description: "startCodeableConcept" : { CodeableConcept },
FHIR Version: dstu2
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"startCodeableConcept": Learn more about the (Goal) startCodeableConcept FHIR attribute
Description: "targetQuantity" : { Quantity(Duration) },
FHIR Version: dstu2
Attribute Type : Quantity
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"targetQuantity": Learn more about the (Goal) targetQuantity FHIR attribute
Description: Who's responsible for creating Goal?
FHIR Version: dstu2
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"author": Learn more about the (Goal) author FHIR attribute
Description: Who this goal is intended for
FHIR Version: dstu2
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"subject": Learn more about the (Goal) subject FHIR attribute
Description: Reason for current status
FHIR Version: dstu2
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"statusReason": Learn more about the (Goal) statusReason FHIR attribute
Description: Comments about the goal
FHIR Version: dstu2
Attribute Type : Annotation
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"note": Learn more about the (Goal) note FHIR attribute
Description: proposed | planned | accepted | rejected | in-progress | achieved | sustaining | on-hold | cancelled
FHIR Version: dstu2
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"status": Learn more about the (Goal) status FHIR attribute
Description: When goal status took effect
FHIR Version: dstu2
Attribute Type : date
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"statusDate": Learn more about the (Goal) statusDate FHIR attribute
Description: high | medium |low
FHIR Version: dstu2
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"priority": Learn more about the (Goal) priority FHIR attribute
Description: What was end result of goal?
FHIR Version: dstu2
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"outcome": Learn more about the (Goal) outcome FHIR attribute
Description: "targetDate" : "<date>",
FHIR Version: dstu2
Attribute Type : date
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"targetDate": Learn more about the (Goal) targetDate FHIR attribute
Description: What's the desired outcome?
FHIR Version: dstu2
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"description": Learn more about the (Goal) description FHIR attribute
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 them 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 |
