Goal - FHIR Resource (r4)
This Goal Resource uses the FHIR API standard for access and structure.
Validate an Goal FHIR Resource (r4)
Goal Attributes
AttributeField is listTypeDescription
Description: External Ids for this goal
FHIR Version: r4
Attribute Type : Identifier
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"identifier": [
{
"value": "123"
}
]Learn more about the (Goal) identifier FHIR attribute
Description: proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected
FHIR Version: r4
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"lifecycleStatus": "on-hold"Learn more about the (Goal) lifecycleStatus FHIR attribute
Description: in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"achievementStatus": Learn more about the (Goal) achievementStatus FHIR attribute
Description: E.g. Treatment, dietary, behavioral, etc.
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/goal-category",
"code": "dietary"
}
]
}
]Learn more about the (Goal) category FHIR attribute
Description: high-priority | medium-priority | low-priority
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"priority": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/goal-priority",
"code": "high-priority",
"display": "High Priority"
}
],
"text": "high"
}Learn more about the (Goal) priority FHIR attribute
Description: Code or text describing goal
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"description": {
"text": "Target weight is 160 to 180 lbs."
}Learn more about the (Goal) description FHIR attribute
Description: Who this goal is intended for
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"subject": {
"reference": "Patient/example",
"display": "Peter James Chalmers"
}Learn more about the (Goal) subject FHIR attribute
Description:
FHIR Version: r4
Attribute Type : date|CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"start[x]": Learn more about the (Goal) start[x] FHIR attribute
Description: C? Target outcome for the goal
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"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"
}
]Learn more about the (Goal) target FHIR attribute
Description: When goal status took effect
FHIR Version: r4
Attribute Type : date
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"statusDate": "2016-02-14"Learn more about the (Goal) statusDate FHIR attribute
Description: Reason for current status
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"statusReason": "Patient wants to defer weight loss until after honeymoon."Learn more about the (Goal) statusReason FHIR attribute
Description: "expressedBy" : { Reference(Patient|Practitioner|PractitionerRole|
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"expressedBy": {
"reference": "Patient/example",
"display": "Peter James Chalmers"
}Learn more about the (Goal) expressedBy FHIR attribute
Description: "addresses" : [{ Reference(Condition|Observation|MedicationStatement|
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"addresses": [
{
"display": "obesity condition"
}
]Learn more about the (Goal) addresses FHIR attribute
Description: Comments about the goal
FHIR Version: r4
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: What result was achieved regarding the goal?
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"outcomeCode": Learn more about the (Goal) outcomeCode FHIR attribute
Description: Observation that resulted from goal
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"outcomeReference": [
{
"reference": "Observation/example",
"display": "Body Weight Measured"
}
]Learn more about the (Goal) outcomeReference FHIR attribute
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 Parameter | Field Type | Resource Fields Searched |
|---|---|---|
achievement-status | text | achievementStatus |
category | text | category |
identifier | text | identifier |
lifecycle-status | text | lifecycleStatus |
patient | reference | subject.where |
start-date | date | start |
subject | reference | subject |
target-date | date | target.due |
