Image Goals

Goal requests and examples

Terminology Bindings

Terminology Detail
Goal.category Indicates a category the goal falls within.

Parameters

Parameter Is Required Description
Id This, or patient. The logical resource ID associated with the resource.
patient This, or ID The patient who has the goal.
_revinclude No A request to include any Provenance resource in the bundle.

Goal Requests

Goal by Patient

GET: 'https://api.practicestudio.net/patientportal/fhir/Goal?patient={Patient_ID}'

Goal by Resource ID

GET: 'https://api.practicestudio.net/patientportal/fhir/Goal/{Resource_ID}'

Goal Example Response

Example Goal JSON Response:


{
  "resourceType": "Bundle",
  "meta": {
    "lastUpdated": "2022-08-11T14:48:04.2413065-05:00"
  },
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self"
    }
  ],
  "entry": [
    {
      "resource": {
        "resourceType": "Goal",
        "id": "10206948",
        "meta": {
          "lastUpdated": "0001-01-01T00:00:00-06:00",
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-goal"
          ]
        },
        "lifecycleStatus": "planned",
        "category": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/goal-category",
                "code": "physiotherapy",
                "userSelected": false
              }
            ]
          }
        ],
        "description": {
          "text": "The short term goals are to maintain overall function of the affected areas."
        },
        "subject": {
          "reference": "Patient/000034"
        },
        "target": [
          {
            "dueDate": "2022-10-11"
          }
        ],
        "statusDate": "2020-12-27"
      },
      "search": {
        "mode": "match",
        "score": 1
      }
    }
  ]
}