v1

latestSwagger 2.02026-08-061791731.4 MB

Goals

{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/care-plan/health-concerns/:healthConcernId/goals

Gets a patient's care plan goals for a specified encounter and health concern.

get/persons/{personId}/chart/encounters/{encounterId}/care-plan/health-concerns/{healthConcernId}/goals

Path parameters

personIdstring required

(Required) (Required) The id of the patient whose goals are being fetched

encounterIdstring required

(Required) (Required) The id of the patient encounter whose goals are being fetched

healthConcernIdstring required

(Required) (Required) The id of the health concern whose goals are being fetched

Query parameters

$topstring required

$filterstring required

$orderbystring required

$skipstring required

$inlinecountstring required

$countstring required

Headers

Acceptstring required

Response

NextPageLinkstring required

Countstring required

Example response

{
  "Items": [
    {
      "goalId": "<string>",
      "personId": "<string>",
      "encounterId": "<string>",
      "healthConcernId": "<string>",
      "codeDescription": "<string>",
      "codeSystem": "<string>",
      "codeValue": "<string>",
      "comments": "<string>",
      "isDeleted": "<string>",
      "description": "<string>",
      "isGoalAchieved": "<string>",
      "goalAchievedDetails": "<string>",
      "goalCompletionDate": "<string>",
      "goalStartDate": "<string>",
      "isPatientGoal": "<string>",
      "patientPriority": "<string>",
      "isProviderGoal": "<string>",
      "providerPriority": "<string>",
      "documentedBy": "<string>",
      "encounterDate": "<string>",
      "sequenceNumber": "<string>",
      "createdBy": "<string>",
      "createTimestamp": "<string>",
      "modifiedBy": "<string>",
      "modifyTimestamp": "<string>",
      "createTimestampTimezone": "<string>",
      "modifyTimestampTimezone": "<string>",
      "_links": [
        {
          "href": "<string>",
          "method": "<string>",
          "rel": "<string>",
          "description": "<string>",
          "vendorExtensions": "<string>"
        },
        {
          "href": "<string>",
          "method": "<string>",
          "rel": "<string>",
          "description": "<string>",
          "vendorExtensions": "<string>"
        }
      ]
    },
    {
      "goalId": "<string>",
      "personId": "<string>",
      "encounterId": "<string>",
      "healthConcernId": "<string>",
      "codeDescription": "<string>",
      "codeSystem": "<string>",
      "codeValue": "<string>",
      "comments": "<string>",
      "isDeleted": "<string>",
      "description": "<string>",
      "isGoalAchieved": "<string>",
      "goalAchievedDetails": "<string>",
      "goalCompletionDate": "<string>",
      "goalStartDate": "<string>",
      "isPatientGoal": "<string>",
      "patientPriority": "<string>",
      "isProviderGoal": "<string>",
      "providerPriority": "<string>",
      "documentedBy": "<string>",
      "encounterDate": "<string>",
      "sequenceNumber": "<string>",
      "createdBy": "<string>",
      "createTimestamp": "<string>",
      "modifiedBy": "<string>",
      "modifyTimestamp": "<string>",
      "createTimestampTimezone": "<string>",
      "modifyTimestampTimezone": "<string>",
      "_links": [
        {
          "href": "<string>",
          "method": "<string>",
          "rel": "<string>",
          "description": "<string>",
          "vendorExtensions": "<string>"
        },
        {
          "href": "<string>",
          "method": "<string>",
          "rel": "<string>",
          "description": "<string>",
          "vendorExtensions": "<string>"
        }
      ]
    }
  ],
  "NextPageLink": "<string>",
  "Count": "<string>"
}