Goal

Describes the intended objective(s) for a patient, group or organization

http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-goal.html

To learn more about how to create goals within the Canvas UI see this Zendesk article.

get
/Goal/{id}

Goal read

Path Parameters

id required
string
The unique identifier for the Goal

Response Payload Attributes

resourceType
string

The FHIR Resource name.

id
string

The Canvas identifier of the goal.

lifecycleStatus
enum [ active | completed | entered-in-error ]

State the goal is in throughout its lifecycle.

- Goals that have been closed using a Close Goal Command will have a staus of completed.
- Goal commands that were entered-in-error will have a status of entered-in-error.
- All goals that are not closed will have the active status.

achievementStatus
json

Describes progress made on goal, from http://terminology.hl7.org/CodeSystem/goal-achievement. This correspondes to the Status field on the latest committed goal related command.

Click to view child attributes
coding
array[json]

Code defined by a terminology system.

Click to view child attributes
system
string

The system url of the coding.

Value Options Supported:
  • http://terminology.hl7.org/CodeSystem/goal-achievement
code
string

The code.

Value Options Supported:
  • in-progress
  • improving
  • worsening
  • no-change
  • achieved
  • sustaining
  • not-achieved
  • no-progress
  • not-attainable
display
string

The display name of the coding.

priority
json

Level of importance associated with the reaching/sustaining goal, from http://terminology.hl7.org/CodeSystem/goal-priority. This correspondes to the Priority field on the latest committed goal related command.

Click to view child attributes
system
string

The system url of the coding.

Value Options Supported:
  • http://terminology.hl7.org/CodeSystem/goal-achievement
code
string

The code.

Value Options Supported:
  • high-priority
  • medium-priority
  • low-priority
display
string

The display name of the coding.

description
json

Human readable text of the goal.

Click to view child attributes
text
string

Plain text representation of the concept.

subject
json

Canvas Patient resource the goal is for.

Click to view child attributes
reference
string

The reference string of the subject in the format of "Patient/a39cafb9d1b445be95a2e2548e12a787".

type
string

Type the reference refers to (e.g. “Patient”).

startDate
date

When goal pursuit begins.

target
array[json]

A single iteration of this field with the dueDate, if available. This correspondes to the Due date field on the latest committed goal related command.

Click to view child attributes
dueDate
date

Reach goal on or before.

expressedBy
json

Who created the goal, a Practitioner resource. This is the committer of the goal command in the patient’s chart.

Click to view child attributes
reference
string

The reference string of the practitioner in the format of "Practitioner/a39cafb9d1b445be95a2e2548e12a787".

type
string

Type the reference refers to (e.g. “Practitioner”).

note
array[json]

Comments about the goal and who wrote them. Notes correspondes to any progress/barriers submitted on any of goal related commands.

Click to view child attributes
id
string

The Canvas identifier of the goal’s note.

authorReference
json

Individual responsible for the annotation.

Click to view child attributes
reference
string

The reference string of the practitioner in the format of "Practitioner/a39cafb9d1b445be95a2e2548e12a787".

type
string

Type the reference refers to (e.g. “Practitioner”).

time
datetime

When the annotation was made.

text
string

The annotation - text content.

Responses

200 OK
Request was successful.

Errors

401 Unauthorized
The request requires user authentication.
403 Forbidden
The request requires user authorization.
404 Not Found
The requested resource was not found.

Query Parameters

_id
string

A Canvas-issued unique identifier for a specific goal.

patient
string

Who this goal is intended for in the format Patient/a39cafb9d1b445be95a2e2548e12a787.

Response Payload Attributes

resourceType
string

The FHIR Resource name.

type
string

This element and value designate that the bundle is a search response. Search result bundles will always have the Bundle.type of searchset .

total
integer

The number of resources that match the search parameter.

link
array[json]

Attributes relevant to pagination, see our Pagination page for more detail.

Click to view child attributes
relation
enum [self|first|next|last]

The relation of the page search

url

The search url for the specific relation

entry
array[json]

The results bundle that lists out each object returned in the search

Click to view child attributes
resource
json

The attributes specific to the resource type, see the Attributes section below

Attributes

resourceType
string

The FHIR Resource name.

id
string

The Canvas identifier of the goal.

lifecycleStatus
enum [ active | completed | entered-in-error ]

State the goal is in throughout its lifecycle.

- Goals that have been closed using a Close Goal Command will have a staus of completed.
- Goal commands that were entered-in-error will have a status of entered-in-error.
- All goals that are not closed will have the active status.

achievementStatus
json

Describes progress made on goal, from http://terminology.hl7.org/CodeSystem/goal-achievement. This correspondes to the Status field on the latest committed goal related command.

Click to view child attributes
coding
array[json]

Code defined by a terminology system.

Click to view child attributes
system
string

The system url of the coding.

Value Options Supported:
  • http://terminology.hl7.org/CodeSystem/goal-achievement
code
string

The code.

Value Options Supported:
  • in-progress
  • improving
  • worsening
  • no-change
  • achieved
  • sustaining
  • not-achieved
  • no-progress
  • not-attainable
display
string

The display name of the coding.

priority
json

Level of importance associated with the reaching/sustaining goal, from http://terminology.hl7.org/CodeSystem/goal-priority. This correspondes to the Priority field on the latest committed goal related command.

Click to view child attributes
system
string

The system url of the coding.

Value Options Supported:
  • http://terminology.hl7.org/CodeSystem/goal-achievement
code
string

The code.

Value Options Supported:
  • high-priority
  • medium-priority
  • low-priority
display
string

The display name of the coding.

description
json

Human readable text of the goal.

Click to view child attributes
text
string

Plain text representation of the concept.

subject
json

Canvas Patient resource the goal is for.

Click to view child attributes
reference
string

The reference string of the subject in the format of "Patient/a39cafb9d1b445be95a2e2548e12a787".

type
string

Type the reference refers to (e.g. “Patient”).

startDate
date

When goal pursuit begins.

target
array[json]

A single iteration of this field with the dueDate, if available. This correspondes to the Due date field on the latest committed goal related command.

Click to view child attributes
dueDate
date

Reach goal on or before.

expressedBy
json

Who created the goal, a Practitioner resource. This is the committer of the goal command in the patient’s chart.

Click to view child attributes
reference
string

The reference string of the practitioner in the format of "Practitioner/a39cafb9d1b445be95a2e2548e12a787".

type
string

Type the reference refers to (e.g. “Practitioner”).

note
array[json]

Comments about the goal and who wrote them. Notes correspondes to any progress/barriers submitted on any of goal related commands.

Click to view child attributes
id
string

The Canvas identifier of the goal’s note.

authorReference
json

Individual responsible for the annotation.

Click to view child attributes
reference
string

The reference string of the practitioner in the format of "Practitioner/a39cafb9d1b445be95a2e2548e12a787".

type
string

Type the reference refers to (e.g. “Practitioner”).

time
datetime

When the annotation was made.

text
string

The annotation - text content.

Responses

200 OK
Request was successful.

Errors

400 Bad Request
The request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401 Unauthorized
The request requires user authentication.
403 Forbidden
The request requires user authorization.
  • curl --request GET \
         --url 'https://fumage-example.canvasmedical.com/Goal/<id>' \
         --header 'Authorization: Bearer <token>' \
         --header 'accept: application/json'
    
  • import requests
    
    url = "https://fumage-example.canvasmedical.com/Goal/<id>"
    
    headers = {
        "accept": "application/json",
        "Authorization": "Bearer <token>"
    }
    
    response = requests.get(url, headers=headers)
    
    print(response.text)
    
  • {
      "resourceType": "Goal",
      "id": "e04a62f8-e6ab-46a1-af34-b635f901e37b",
      "lifecycleStatus": "active",
      "achievementStatus": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/goal-achievement",
              "code": "improving",
              "display": "Improving"
            }
          ]
      },
      "priority": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/goal-priority",
              "code": "medium-priority",
              "display": "Medium Priority"
            }
          ]
      },
      "description": {
          "text": "Drink more water"
      },
      "subject": {
          "reference": "Patient/f3d750f5d77d403c96baef6a6055c6e7",
          "type": "Patient"
      },
      "startDate": "2022-01-27",
      "target": [
        {
          "dueDate": "2023-09-28"
        }
      ],
      "expressedBy": {
          "reference": "Practitioner/4150cd20de8a470aa570a852859ac87e",
          "type": "Practitioner"
      },
      "note": [
        {
          "id": "c2a45d52-b3d7-4e57-bb70-2b82b8819305",
          "authorReference": {
              "reference": "Practitioner/4150cd20de8a470aa570a852859ac87e",
              "type": "Practitioner"
          },
          "time": "2023-09-19T20:50:25.955348+00:00",
          "text": "Patient unable to find time to drink during work hours, shows signs of dehydration and fatigue"
        }
      ]
    }
    
  • {
      "resourceType": "OperationOutcome",
      "issue": [
        {
          "severity": "error",
          "code": "unknown",
          "details": {
            "text": "Authentication failed"
          }
        }
      ]
    }
    
  • {
      "resourceType": "OperationOutcome",
      "issue": [
        {
          "severity": "error",
          "code": "forbidden",
          "details": {
            "text": "Authorization failed"
          }
        }
      ]
    }
    
  • {
      "resourceType": "OperationOutcome",
      "issue": [
        {
          "severity": "error",
          "code": "not-found",
          "details": {
            "text": "Unknown Goal resource 'a47c7b0ebbb442cdbc4adf259d148ea1'"
          }
        }
      ]
    }
    
  • curl --request GET \
         --url 'https://fumage-example.canvasmedical.com/Goal?patient=Patient/f3d750f5d77d403c96baef6a6055c6e7' \
         --header 'Authorization: Bearer <token>' \
         --header 'accept: application/json'
    
  • import requests
    
    url = "https://fumage-example.canvasmedical.com/Goal?patient=Patient/f3d750f5d77d403c96baef6a6055c6e7"
    
    headers = {
        "accept": "application/json",
        "Authorization": "Bearer <token>"
    }
    
    response = requests.get(url, headers=headers)
    
    print(response.text)
    
  • {
        "resourceType": "Bundle",
        "type": "searchset",
        "total": 2,
        "link": [
        {
            "relation": "self",
            "url": "/Goal?patient=Patient/f3d750f5d77d403c96baef6a6055c6e7&_count=10&_offset=0"
          },
          {
            "relation": "first",
            "url": "/Goal?patient=Patient/f3d750f5d77d403c96baef6a6055c6e7&_count=10&_offset=0"
          },
          {
            "relation": "last",
            "url": "/Goal?patient=Patient/f3d750f5d77d403c96baef6a6055c6e7&_count=10&_offset=0"
          }
        ],
        "entry": [
          {
            "resource": {
                "resourceType": "Goal",
                "id": "d942b2b6-5c87-4f95-b7d6-51e2355aabf5",
                "lifecycleStatus": "completed",
                "achievementStatus": {
                    "coding": [
                      {
                        "system": "http://terminology.hl7.org/CodeSystem/goal-achievement",
                        "code": "improving",
                        "display": "Improving"
                      }
                    ]
                },
                "priority": {
                    "coding": [
                      {
                        "system": "http://terminology.hl7.org/CodeSystem/goal-priority",
                        "code": "medium-priority",
                        "display": "Medium Priority"
                      }
                    ]
                },
                "description": {
                    "text": "Eat one veggie a day"
                },
                "subject": {
                    "reference": "Patient/f3d750f5d77d403c96baef6a6055c6e7",
                    "type": "Patient"
                },
                "startDate": "2022-12-06",
                "expressedBy": {
                    "reference": "Practitioner/4150cd20de8a470aa570a852859ac87e",
                    "type": "Practitioner"
                },
                "note": [
                  {
                    "id": "fe2365c7-1a87-43c3-8846-fc26349a8797",
                    "authorReference": {
                        "reference": "Practitioner/4150cd20de8a470aa570a852859ac87e",
                        "type": "Practitioner"
                    },
                    "time": "2022-12-06T17:21:25.172196+00:00",
                    "text": "Not going well only eat skittles"
                  }
                ]
            }
          },
          {
            "resource": {
                "resourceType": "Goal",
                "id": "730e38b4-afaf-476c-914c-5eb0b2de405d",
                "lifecycleStatus": "active",
                "achievementStatus": {
                  "coding": [
                    {
                      "system": "http://terminology.hl7.org/CodeSystem/goal-achievement",
                      "code": "improving",
                      "display": "Improving"
                    }
                  ]
                },
                "description": {
                    "text": "Walk 3 steps each day"
                },
                "subject": {
                    "reference": "Patient/f3d750f5d77d403c96baef6a6055c6e7",
                    "type": "Patient"
                },
                "startDate": "2023-03-03",
                "expressedBy": {
                    "reference": "Practitioner/4150cd20de8a470aa570a852859ac87e",
                    "type": "Practitioner"
                }
              }
          }
        ]
    }
    
  • {
      "resourceType": "OperationOutcome",
      "issue": [
        {
          "severity": "error",
          "code": "invalid",
          "details": {
            "text": "Bad request"
          }
        }
      ]
    }
    
  • {
      "resourceType": "OperationOutcome",
      "issue": [
        {
          "severity": "error",
          "code": "unknown",
          "details": {
            "text": "Authentication failed"
          }
        }
      ]
    }
    
  • {
      "resourceType": "OperationOutcome",
      "issue": [
        {
          "severity": "error",
          "code": "forbidden",
          "details": {
            "text": "Authorization failed"
          }
        }
      ]
    }