Goal
Describes the intended objective(s) for a patient, group or organization care, for example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc.
Columns
Header row
# |
path |
type |
required |
description |
0 |
resourceType |
string |
* |
Resource type identifier. Must be string "Goal" |
1 |
|
integer |
* |
Number of subrows |
2 |
id |
string |
* |
Logical id of this artifact |
3 |
lifecycleStatus |
code |
|
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 |
|
achievementStatus.coding |
Coding |
|
Code defined by a terminology system |
4 |
achievementStatus.coding.system |
uri |
|
Identity of the terminology system |
5 |
achievementStatus.coding.version |
string |
|
Version of the system - if relevant |
6 |
achievementStatus.coding.code |
code |
|
Symbol in syntax defined by the system |
7 |
achievementStatus.coding.display |
string |
|
Representation defined by the system |
8 |
achievementStatus.coding.userSelected |
boolean |
|
If this coding was chosen directly by the user |
9 |
achievementStatus.text |
string |
|
Plain text representation of the concept |
|
priority |
CodeableConcept |
|
high-priority | medium-priority | low-priority |
|
priority.coding |
Coding |
|
Code defined by a terminology system |
10 |
priority.coding.system |
uri |
|
Identity of the terminology system |
11 |
priority.coding.version |
string |
|
Version of the system - if relevant |
12 |
priority.coding.code |
code |
|
Symbol in syntax defined by the system |
13 |
priority.coding.display |
string |
|
Representation defined by the system |
14 |
priority.coding.userSelected |
boolean |
|
If this coding was chosen directly by the user |
15 |
priority.text |
string |
|
Plain text representation of the concept |
|
description |
CodeableConcept |
|
Code or text describing goal |
|
description.coding |
Coding |
|
Code defined by a terminology system |
16 |
description.coding.system |
uri |
|
Identity of the terminology system |
17 |
description.coding.version |
string |
|
Version of the system - if relevant |
18 |
description.coding.code |
code |
|
Symbol in syntax defined by the system |
19 |
description.coding.display |
string |
|
Representation defined by the system |
20 |
description.coding.userSelected |
boolean |
|
If this coding was chosen directly by the user |
21 |
description.text |
string |
|
Plain text representation of the concept |
|
subject |
Reference |
|
Who this goal is intended for |
22 |
subject.reference |
string |
|
Literal reference, Relative, internal or absolute URL |
23 |
subject.type |
uri |
|
Type the reference refers to (e.g. "Patient") |
|
subject.identifier |
Identifier |
|
Logical reference, when literal reference is not known |
24 |
subject.identifier.use |
code |
|
usual | official | temp | secondary | old (If known) |
|
subject.identifier.type |
CodeableConcept |
|
Description of identifier |
|
subject.identifier.type.coding |
Coding |
|
Code defined by a terminology system |
25 |
subject.identifier.type.coding.system |
uri |
|
Identity of the terminology system |
26 |
subject.identifier.type.coding.version |
string |
|
Version of the system - if relevant |
27 |
subject.identifier.type.coding.code |
code |
|
Symbol in syntax defined by the system |
28 |
subject.identifier.type.coding.display |
string |
|
Representation defined by the system |
29 |
subject.identifier.type.coding.userSelected |
boolean |
|
If this coding was chosen directly by the user |
30 |
subject.identifier.type.text |
string |
|
Plain text representation of the concept |
31 |
subject.identifier.system |
uri |
|
The namespace for the identifier value |
32 |
subject.identifier.value |
string |
|
The value that is unique |
|
subject.identifier.period |
Period |
|
Time period when id is/was valid for use |
33 |
subject.identifier.period.start |
dateTime |
|
Starting time with inclusive boundary |
34 |
subject.identifier.period.end |
dateTime |
|
End time with inclusive boundary, if not ongoing |
35 |
subject.display |
string |
|
Text alternative for the resource |
|
start[x] |
|
|
When goal pursuit begins |
36 |
startDate |
date |
|
|
|
startCodeableConcept |
CodeableConcept |
|
|
|
startCodeableConcept.coding |
Coding |
|
Code defined by a terminology system |
37 |
startCodeableConcept.coding.system |
uri |
|
Identity of the terminology system |
38 |
startCodeableConcept.coding.version |
string |
|
Version of the system - if relevant |
39 |
startCodeableConcept.coding.code |
code |
|
Symbol in syntax defined by the system |
40 |
startCodeableConcept.coding.display |
string |
|
Representation defined by the system |
41 |
startCodeableConcept.coding.userSelected |
boolean |
|
If this coding was chosen directly by the user |
42 |
startCodeableConcept.text |
string |
|
Plain text representation of the concept |
43 |
statusDate |
date |
|
When goal status took effect |
44 |
statusReason |
string |
|
Reason for current status |
|
expressedBy |
Reference |
|
Who's responsible for creating Goal? |
45 |
expressedBy.reference |
string |
|
Literal reference, Relative, internal or absolute URL |
46 |
expressedBy.type |
uri |
|
Type the reference refers to (e.g. "Patient") |
|
expressedBy.identifier |
Identifier |
|
Logical reference, when literal reference is not known |
47 |
expressedBy.identifier.use |
code |
|
usual | official | temp | secondary | old (If known) |
|
expressedBy.identifier.type |
CodeableConcept |
|
Description of identifier |
|
expressedBy.identifier.type.coding |
Coding |
|
Code defined by a terminology system |
48 |
expressedBy.identifier.type.coding.system |
uri |
|
Identity of the terminology system |
49 |
expressedBy.identifier.type.coding.version |
string |
|
Version of the system - if relevant |
50 |
expressedBy.identifier.type.coding.code |
code |
|
Symbol in syntax defined by the system |
51 |
expressedBy.identifier.type.coding.display |
string |
|
Representation defined by the system |
52 |
expressedBy.identifier.type.coding.userSelected |
boolean |
|
If this coding was chosen directly by the user |
53 |
expressedBy.identifier.type.text |
string |
|
Plain text representation of the concept |
54 |
expressedBy.identifier.system |
uri |
|
The namespace for the identifier value |
55 |
expressedBy.identifier.value |
string |
|
The value that is unique |
|
expressedBy.identifier.period |
Period |
|
Time period when id is/was valid for use |
56 |
expressedBy.identifier.period.start |
dateTime |
|
Starting time with inclusive boundary |
57 |
expressedBy.identifier.period.end |
dateTime |
|
End time with inclusive boundary, if not ongoing |
58 |
expressedBy.display |
string |
|
Text alternative for the resource |
Row identifier
# |
path |
type |
required |
description |
0 |
|
string |
* |
Subrow identifier. Must be string "identifier" |
|
identifier |
Identifier |
|
External Ids for this goal |
1 |
identifier.use |
code |
|
usual | official | temp | secondary | old (If known) |
|
identifier.type |
CodeableConcept |
|
Description of identifier |
|
identifier.type.coding |
Coding |
|
Code defined by a terminology system |
2 |
identifier.type.coding.system |
uri |
|
Identity of the terminology system |
3 |
identifier.type.coding.version |
string |
|
Version of the system - if relevant |
4 |
identifier.type.coding.code |
code |
|
Symbol in syntax defined by the system |
5 |
identifier.type.coding.display |
string |
|
Representation defined by the system |
6 |
identifier.type.coding.userSelected |
boolean |
|
If this coding was chosen directly by the user |
7 |
identifier.type.text |
string |
|
Plain text representation of the concept |
8 |
identifier.system |
uri |
|
The namespace for the identifier value |
9 |
identifier.value |
string |
|
The value that is unique |
|
identifier.period |
Period |
|
Time period when id is/was valid for use |
10 |
identifier.period.start |
dateTime |
|
Starting time with inclusive boundary |
11 |
identifier.period.end |
dateTime |
|
End time with inclusive boundary, if not ongoing |
Row category
# |
path |
type |
required |
description |
0 |
|
string |
* |
Subrow identifier. Must be string "category" |
|
category |
CodeableConcept |
|
E.g. Treatment, dietary, behavioral, etc. |
|
category.coding |
Coding |
|
Code defined by a terminology system |
1 |
category.coding.system |
uri |
|
Identity of the terminology system |
2 |
category.coding.version |
string |
|
Version of the system - if relevant |
3 |
category.coding.code |
code |
|
Symbol in syntax defined by the system |
4 |
category.coding.display |
string |
|
Representation defined by the system |
5 |
category.coding.userSelected |
boolean |
|
If this coding was chosen directly by the user |
6 |
category.text |
string |
|
Plain text representation of the concept |
Row target
# |
path |
type |
required |
description |
0 |
|
string |
* |
Subrow identifier. Must be string "target" |
|
target |
|
|
Target outcome for the goal |
|
target.measure |
CodeableConcept |
|
The parameter whose value is being tracked |
|
target.measure.coding |
Coding |
|
Code defined by a terminology system |
1 |
target.measure.coding.system |
uri |
|
Identity of the terminology system |
2 |
target.measure.coding.version |
string |
|
Version of the system - if relevant |
3 |
target.measure.coding.code |
code |
|
Symbol in syntax defined by the system |
4 |
target.measure.coding.display |
string |
|
Representation defined by the system |
5 |
target.measure.coding.userSelected |
boolean |
|
If this coding was chosen directly by the user |
6 |
target.measure.text |
string |
|
Plain text representation of the concept |
|
target.detail[x] |
|
|
The target value to be achieved |
|
target.detailQuantity |
Quantity |
|
|
7 |
target.detailQuantity.value |
decimal |
|
Numerical value (with implicit precision) |
8 |
target.detailQuantity.comparator |
code |
|
< | <= | >= | > - how to understand the value |
9 |
target.detailQuantity.unit |
string |
|
Unit representation |
10 |
target.detailQuantity.system |
uri |
|
System that defines coded unit form |
11 |
target.detailQuantity.code |
code |
|
Coded form of the unit |
|
target.detailRange |
Range |
|
|
|
target.detailRange.low |
Quantity |
|
Low limit |
12 |
target.detailRange.low.value |
decimal |
|
Numerical value (with implicit precision) |
13 |
target.detailRange.low.unit |
string |
|
Unit representation |
14 |
target.detailRange.low.system |
uri |
|
System that defines coded unit form |
15 |
target.detailRange.low.code |
code |
|
Coded form of the unit |
|
target.detailRange.high |
Quantity |
|
High limit |
16 |
target.detailRange.high.value |
decimal |
|
Numerical value (with implicit precision) |
17 |
target.detailRange.high.unit |
string |
|
Unit representation |
18 |
target.detailRange.high.system |
uri |
|
System that defines coded unit form |
19 |
target.detailRange.high.code |
code |
|
Coded form of the unit |
|
target.detailCodeableConcept |
CodeableConcept |
|
|
|
target.detailCodeableConcept.coding |
Coding |
|
Code defined by a terminology system |
20 |
target.detailCodeableConcept.coding.system |
uri |
|
Identity of the terminology system |
21 |
target.detailCodeableConcept.coding.version |
string |
|
Version of the system - if relevant |
22 |
target.detailCodeableConcept.coding.code |
code |
|
Symbol in syntax defined by the system |
23 |
target.detailCodeableConcept.coding.display |
string |
|
Representation defined by the system |
24 |
target.detailCodeableConcept.coding.userSelected |
boolean |
|
If this coding was chosen directly by the user |
25 |
target.detailCodeableConcept.text |
string |
|
Plain text representation of the concept |
26 |
target.detailString |
string |
|
|
27 |
target.detailBoolean |
boolean |
|
|
28 |
target.detailInteger |
integer |
|
|
|
target.detailRatio |
Ratio |
|
|
|
target.detailRatio.numerator |
Quantity |
|
Numerator value |
29 |
target.detailRatio.numerator.value |
decimal |
|
Numerical value (with implicit precision) |
30 |
target.detailRatio.numerator.comparator |
code |
|
< | <= | >= | > - how to understand the value |
31 |
target.detailRatio.numerator.unit |
string |
|
Unit representation |
32 |
target.detailRatio.numerator.system |
uri |
|
System that defines coded unit form |
33 |
target.detailRatio.numerator.code |
code |
|
Coded form of the unit |
|
target.detailRatio.denominator |
Quantity |
|
Denominator value |
34 |
target.detailRatio.denominator.value |
decimal |
|
Numerical value (with implicit precision) |
35 |
target.detailRatio.denominator.comparator |
code |
|
< | <= | >= | > - how to understand the value |
36 |
target.detailRatio.denominator.unit |
string |
|
Unit representation |
37 |
target.detailRatio.denominator.system |
uri |
|
System that defines coded unit form |
38 |
target.detailRatio.denominator.code |
code |
|
Coded form of the unit |
|
target.due[x] |
|
|
Reach goal on or before |
39 |
target.dueDate |
date |
|
|
|
target.dueDuration |
Duration |
|
|
40 |
target.dueDuration.value |
decimal |
|
Numerical value (with implicit precision) |
41 |
target.dueDuration.comparator |
code |
|
< | <= | >= | > - how to understand the value |
42 |
target.dueDuration.unit |
string |
|
Unit representation |
43 |
target.dueDuration.system |
uri |
|
System that defines coded unit form |
44 |
target.dueDuration.code |
code |
|
Coded form of the unit |
Row addresses
# |
path |
type |
required |
description |
0 |
|
string |
* |
Subrow identifier. Must be string "addresses" |
|
addresses |
Reference |
|
Issues addressed by this goal |
1 |
addresses.reference |
string |
|
Literal reference, Relative, internal or absolute URL |
2 |
addresses.type |
uri |
|
Type the reference refers to (e.g. "Patient") |
|
addresses.identifier |
Identifier |
|
Logical reference, when literal reference is not known |
3 |
addresses.identifier.use |
code |
|
usual | official | temp | secondary | old (If known) |
|
addresses.identifier.type |
CodeableConcept |
|
Description of identifier |
|
addresses.identifier.type.coding |
Coding |
|
Code defined by a terminology system |
4 |
addresses.identifier.type.coding.system |
uri |
|
Identity of the terminology system |
5 |
addresses.identifier.type.coding.version |
string |
|
Version of the system - if relevant |
6 |
addresses.identifier.type.coding.code |
code |
|
Symbol in syntax defined by the system |
7 |
addresses.identifier.type.coding.display |
string |
|
Representation defined by the system |
8 |
addresses.identifier.type.coding.userSelected |
boolean |
|
If this coding was chosen directly by the user |
9 |
addresses.identifier.type.text |
string |
|
Plain text representation of the concept |
10 |
addresses.identifier.system |
uri |
|
The namespace for the identifier value |
11 |
addresses.identifier.value |
string |
|
The value that is unique |
|
addresses.identifier.period |
Period |
|
Time period when id is/was valid for use |
12 |
addresses.identifier.period.start |
dateTime |
|
Starting time with inclusive boundary |
13 |
addresses.identifier.period.end |
dateTime |
|
End time with inclusive boundary, if not ongoing |
14 |
addresses.display |
string |
|
Text alternative for the resource |
Row note
# |
path |
type |
required |
description |
0 |
|
string |
* |
Subrow identifier. Must be string "note" |
|
note |
Annotation |
|
Comments about the goal |
|
note.author[x] |
|
|
Individual responsible for the annotation |
|
note.authorReference |
Reference |
|
|
1 |
note.authorReference.reference |
string |
|
Literal reference, Relative, internal or absolute URL |
2 |
note.authorReference.type |
uri |
|
Type the reference refers to (e.g. "Patient") |
|
note.authorReference.identifier |
Identifier |
|
Logical reference, when literal reference is not known |
3 |
note.authorReference.identifier.use |
code |
|
usual | official | temp | secondary | old (If known) |
|
note.authorReference.identifier.type |
CodeableConcept |
|
Description of identifier |
|
note.authorReference.identifier.type.coding |
Coding |
|
Code defined by a terminology system |
4 |
note.authorReference.identifier.type.coding.system |
uri |
|
Identity of the terminology system |
5 |
note.authorReference.identifier.type.coding.version |
string |
|
Version of the system - if relevant |
6 |
note.authorReference.identifier.type.coding.code |
code |
|
Symbol in syntax defined by the system |
7 |
note.authorReference.identifier.type.coding.display |
string |
|
Representation defined by the system |
8 |
note.authorReference.identifier.type.coding.userSelected |
boolean |
|
If this coding was chosen directly by the user |
9 |
note.authorReference.identifier.type.text |
string |
|
Plain text representation of the concept |
10 |
note.authorReference.identifier.system |
uri |
|
The namespace for the identifier value |
11 |
note.authorReference.identifier.value |
string |
|
The value that is unique |
|
note.authorReference.identifier.period |
Period |
|
Time period when id is/was valid for use |
12 |
note.authorReference.identifier.period.start |
dateTime |
|
Starting time with inclusive boundary |
13 |
note.authorReference.identifier.period.end |
dateTime |
|
End time with inclusive boundary, if not ongoing |
14 |
note.authorReference.display |
string |
|
Text alternative for the resource |
15 |
note.authorString |
string |
|
|
16 |
note.time |
dateTime |
|
When the annotation was made |
17 |
note.text |
markdown |
|
The annotation - text content (as markdown) |
Row outcomeCode
# |
path |
type |
required |
description |
0 |
|
string |
* |
Subrow identifier. Must be string "outcomeCode" |
|
outcomeCode |
CodeableConcept |
|
What result was achieved regarding the goal? |
|
outcomeCode.coding |
Coding |
|
Code defined by a terminology system |
1 |
outcomeCode.coding.system |
uri |
|
Identity of the terminology system |
2 |
outcomeCode.coding.version |
string |
|
Version of the system - if relevant |
3 |
outcomeCode.coding.code |
code |
|
Symbol in syntax defined by the system |
4 |
outcomeCode.coding.display |
string |
|
Representation defined by the system |
5 |
outcomeCode.coding.userSelected |
boolean |
|
If this coding was chosen directly by the user |
6 |
outcomeCode.text |
string |
|
Plain text representation of the concept |
Row outcomeReference
# |
path |
type |
required |
description |
0 |
|
string |
* |
Subrow identifier. Must be string "outcomeReference" |
|
outcomeReference |
Reference |
|
Observation that resulted from goal |
1 |
outcomeReference.reference |
string |
|
Literal reference, Relative, internal or absolute URL |
2 |
outcomeReference.type |
uri |
|
Type the reference refers to (e.g. "Patient") |
|
outcomeReference.identifier |
Identifier |
|
Logical reference, when literal reference is not known |
3 |
outcomeReference.identifier.use |
code |
|
usual | official | temp | secondary | old (If known) |
|
outcomeReference.identifier.type |
CodeableConcept |
|
Description of identifier |
|
outcomeReference.identifier.type.coding |
Coding |
|
Code defined by a terminology system |
4 |
outcomeReference.identifier.type.coding.system |
uri |
|
Identity of the terminology system |
5 |
outcomeReference.identifier.type.coding.version |
string |
|
Version of the system - if relevant |
6 |
outcomeReference.identifier.type.coding.code |
code |
|
Symbol in syntax defined by the system |
7 |
outcomeReference.identifier.type.coding.display |
string |
|
Representation defined by the system |
8 |
outcomeReference.identifier.type.coding.userSelected |
boolean |
|
If this coding was chosen directly by the user |
9 |
outcomeReference.identifier.type.text |
string |
|
Plain text representation of the concept |
10 |
outcomeReference.identifier.system |
uri |
|
The namespace for the identifier value |
11 |
outcomeReference.identifier.value |
string |
|
The value that is unique |
|
outcomeReference.identifier.period |
Period |
|
Time period when id is/was valid for use |
12 |
outcomeReference.identifier.period.start |
dateTime |
|
Starting time with inclusive boundary |
13 |
outcomeReference.identifier.period.end |
dateTime |
|
End time with inclusive boundary, if not ongoing |
14 |
outcomeReference.display |
string |
|
Text alternative for the resource |
Examples
Example #1
Input CSV
Goal,5,"example","on-hold",,,,,,,"http://terminology.hl7.org/CodeSystem/goal-priority",,"high-priority","High Priority",,"high",,,,,,"Target weight is 160 to 180 lbs.","Patient/example",,,,,,,,,,,,,"Peter James Chalmers","2015-04-05",,,,,,,"2016-02-14","Patient wants to defer weight loss until after honeymoon.","Patient/example",,,,,,,,,,,,,"Peter James Chalmers"
identifier,,,,,,,,,"123",,
category,"http://terminology.hl7.org/CodeSystem/goal-category",,"dietary",,,
target,"http://loinc.org",,"3141-9","Weight Measured",,,,,,,,160,"lbs","http://unitsofmeasure.org","[lb_av]",180,"lbs","http://unitsofmeasure.org","[lb_av]",,,,,,,,,,,,,,,,,,,,"2016-04-05",,,,,
addresses,,,,,,,,,,,,,,"obesity condition"
outcomeReference,"Observation/example",,,,,,,,,,,,,"Body Weight Measured"
Resulting resource
{
"resourceType": "Goal",
"id": "example",
"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"
}
]
}
Example #2
Input CSV
Goal,2,"stop-smoking","completed","http://terminology.hl7.org/CodeSystem/goal-achievement",,"achieved","Achieved",,"Achieved",,,,,,,,,,,,"Stop smoking","Patient/example",,,,,,,,,,,,,"Peter James Chalmers","2015-04-05",,,,,,,,,,,,,,,,,,,,,,
identifier,,,,,,,,,"123",,
outcomeCode,"http://snomed.info/sct",,"8517006","Ex-smoker (finding)",,"Former smoker"
Resulting resource
{
"resourceType": "Goal",
"id": "stop-smoking",
"identifier": [
{
"value": "123"
}
],
"lifecycleStatus": "completed",
"achievementStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/goal-achievement",
"code": "achieved",
"display": "Achieved"
}
],
"text": "Achieved"
},
"description": {
"text": "Stop smoking"
},
"subject": {
"reference": "Patient/example",
"display": "Peter James Chalmers"
},
"startDate": "2015-04-05",
"outcomeCode": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "8517006",
"display": "Ex-smoker (finding)"
}
],
"text": "Former smoker"
}
]
}