NAV
Ruby Shell

Longitudinal Plan API v1

The longitudinal plan is a centralized, multidisciplinary, and enterprise-wide plan of care that aims to communicate to the person and interested providers the concerns being addressed for the person, the goals the person is striving toward, and the actions and behaviors the person is being asked to perform to help them meet their goals and manage or resolve their concerns. A person’s longitudinal plan is not encounter- or episode-specific; instead, the plan presents a holistic view of a person’s ongoing goals and activities with a focus on clearly communicating to the person what’s expected of them between interactions with the health care system.

Due to the nature of the plan, anybody providing outpatient or ongoing care for a person (for example, providers, care managers, and physical therapists) may need to view and interact with a person’s plan. Additionally, the person, a family member, or a guardian can view and interact with the plan as the person progresses toward their goals.

Note: If you specify an empty, null, or blank query parameter (for example, ?id=%20%20), a 400 (Bad Request) status code is returned.

URL: https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1

Plan Templates

A longitudinal plan template is a preconfigured set of items such as health concerns, goals, and activities that are commonly created together by users when care planning for a specific purpose. Templates allow clients to create a standard approach for how care should be planned in various situations, both to increase efficiency for users and to enforce standards of care. While care planning, a user can search for a plan template to use as a starting point.

The scope of a template should be flexible so that it can support various types of plan items with optional relationships; however, because the intent of templates is to help enforce a standard of care, the focus should be relatively narrow. For example, a single plan template that contains all the activities and goals across disciplines that could possibly be related to diabetes would be too cumbersome to use and too broad to enforce a standard of care. Instead, a plan template designed for care managers to use for adults who are newly diagnosed with type 2 diabetes is more specific and would likely be more helpful for users.

Depending on how the template is intended to be used, a plan template can omit definition types. A single plan template definition should use one of the following forms:

See the following examples of how these variations could be used for care management:

Create a Plan Template

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/plan-templates', headers: headers, body: {"description":"Diabetes Template","status":"ACTIVE","healthConcernDefinitions":[{"id":"11e8901b64b1ca0b9c300d1ad3125a48","goalDefinitions":[{"id":"11e8902c79c4ee348fe5cf0da3dac545","activityDefinitions":[{"id":"11e8902c5fe1e3238afa990c2154a1a3"}],"shortTermGoalDefinitions":[{"id":"22e8902c79c4ee348fe5cf0da3dac656","activityDefinitions":[{"id":"22e8902c5fe1e3238afa990c2154b2b4"}]}]}],"activityDefinitions":[{"id":"11e8902c5fe1e3238afa990c2154a1a3"}]}],"goalDefinitions":[{"id":"11e8902c79c4ee348fe5cf0da3dac545","activityDefinitions":[{"id":"11e8902c5fe1e3238afa990c2154a1a3"}],"shortTermGoalDefinitions":[{"id":"22e8902c79c4ee348fe5cf0da3dac656","activityDefinitions":[{"id":"22e8902c5fe1e3238afa990c2154b2b4"}]}]}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/plan-templates \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"description":"Diabetes Template","status":"ACTIVE","healthConcernDefinitions":[{"id":"11e8901b64b1ca0b9c300d1ad3125a48","goalDefinitions":[{"id":"11e8902c79c4ee348fe5cf0da3dac545","activityDefinitions":[{"id":"11e8902c5fe1e3238afa990c2154a1a3"}],"shortTermGoalDefinitions":[{"id":"22e8902c79c4ee348fe5cf0da3dac656","activityDefinitions":[{"id":"22e8902c5fe1e3238afa990c2154b2b4"}]}]}],"activityDefinitions":[{"id":"11e8902c5fe1e3238afa990c2154a1a3"}]}],"goalDefinitions":[{"id":"11e8902c79c4ee348fe5cf0da3dac545","activityDefinitions":[{"id":"11e8902c5fe1e3238afa990c2154a1a3"}],"shortTermGoalDefinitions":[{"id":"22e8902c79c4ee348fe5cf0da3dac656","activityDefinitions":[{"id":"22e8902c5fe1e3238afa990c2154b2b4"}]}]}]}

Example response

{
  "id": "11e8902c9e2908c69718f13503066bee",
  "healthConcernDefinitions": [
    {
      "id": "11e8901b64b1ca0b9c300d1ad3125a48",
      "goalDefinitions": [
        {
          "id": "11e8902c79c4ee348fe5cf0da3dac545",
          "activityDefinitions": [
            {
              "id": "11e8902c5fe1e3238afa990c2154a1a3"
            }
          ],
          "shortTermGoalDefinitions": [
            {
              "id": "11e8902c79c4ee348fe5cf0da3dac545",
              "activityDefinitions": [
                {
                  "id": "11e8902c5fe1e3238afa990c2154a1a3"
                }
              ]
            }
          ]
        }
      ],
      "activityDefinitions": [
        {
          "id": "11e8902c5fe1e3238afa990c2154a1a3"
        }
      ]
    }
  ],
  "goalDefinitions": [
    {
      "id": "11e8902c79c4ee348fe5cf0da3dac545",
      "activityDefinitions": [
        {
          "id": "11e8902c5fe1e3238afa990c2154a1a3"
        }
      ],
      "shortTermGoalDefinitions": [
        {
          "id": "11e8902c79c4ee348fe5cf0da3dac545",
          "activityDefinitions": [
            {
              "id": "11e8902c5fe1e3238afa990c2154a1a3"
            }
          ]
        }
      ]
    }
  ],
  "createdAt": "2018-07-25T17:03:14.120Z",
  "updatedAt": "2018-07-25T17:03:14.120Z",
  "description": "Diabetes Template",
  "status": "ACTIVE"
}

POST /plan-templates

Creates a plan template.

Parameters

Parameter In Type Required Default Description Accepted Values
body body postPlanTemplates true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created Create a Plan Template PlanTemplate
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
409 Conflict Conflict Error
415 Unsupported Media Type Unsupported Media Type Error

Response Headers

Status Header Type Format Description
201 ETag string The ETag of a specific version of the plan template.

Retrieve a List of Plan Templates

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/plan-templates', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/plan-templates \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "11e8902c9e2908c69718f13503066bee",
      "healthConcernDefinitions": [
        {
          "id": "11e8901b64b1ca0b9c300d1ad3125a48",
          "goalDefinitions": [
            {
              "id": "11e8902c79c4ee348fe5cf0da3dac545",
              "activityDefinitions": [
                {
                  "id": "11e8902c5fe1e3238afa990c2154a1a3"
                }
              ],
              "shortTermGoalDefinitions": [
                {
                  "id": "11e8902c79c4ee348fe5cf0da3dac545",
                  "activityDefinitions": [
                    {
                      "id": "11e8902c5fe1e3238afa990c2154a1a3"
                    }
                  ]
                }
              ]
            }
          ],
          "activityDefinitions": [
            {
              "id": "11e8902c5fe1e3238afa990c2154a1a3"
            }
          ]
        }
      ],
      "goalDefinitions": [
        {
          "id": "11e8902c79c4ee348fe5cf0da3dac545",
          "activityDefinitions": [
            {
              "id": "11e8902c5fe1e3238afa990c2154a1a3"
            }
          ],
          "shortTermGoalDefinitions": [
            {
              "id": "11e8902c79c4ee348fe5cf0da3dac545",
              "activityDefinitions": [
                {
                  "id": "11e8902c5fe1e3238afa990c2154a1a3"
                }
              ]
            }
          ]
        }
      ],
      "createdAt": "2018-07-25T17:03:14.120Z",
      "updatedAt": "2018-07-25T17:03:14.120Z",
      "description": "Diabetes Template",
      "status": "ACTIVE"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/plan-templates?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/plan-templates?offset=0&limit=20"
}

GET /plan-templates

Retrieves a list of plan templates.

Parameters

Parameter In Type Required Default Description Accepted Values
status query array[string] false N/A Filters the retrieved plan templates by status. ACTIVE, INACTIVE
description query string false N/A Filters by the description of the plan template. -
id query array[string] false N/A Filters by the ID of the plan template. -
healthConcernDefinitionId query string false N/A Filters by the ID of the health concern definition. -
goalDefinitionId query string false N/A Filters by the ID of the goal definition. -
activityDefinitionId query string false N/A Filters by the ID of the activity definition. -
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK Retrieve a List of Plan Templates PlanTemplates
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Update a Plan Template

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'If-Match' => {
  "type": "string"
}
} 

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/plan-templates/11e8902c9e2908c69718f13503066bee', headers: headers, body: {"description":"Diabetes Template","status":"ACTIVE","healthConcernDefinitions":[{"id":"11e8901b64b1ca0b9c300d1ad3125a48","goalDefinitions":[{"id":"11e8902c79c4ee348fe5cf0da3dac545","activityDefinitions":[{"id":"11e8902c5fe1e3238afa990c2154a1a3"}],"shortTermGoalDefinitions":[{"id":"22e8902c79c4ee348fe5cf0da3dac656","activityDefinitions":[{"id":"22e8902c5fe1e3238afa990c2154b2b4"}]}]}],"activityDefinitions":[{"id":"11e8902c5fe1e3238afa990c2154a1a3"}]}],"goalDefinitions":[{"id":"11e8902c79c4ee348fe5cf0da3dac545","activityDefinitions":[{"id":"11e8902c5fe1e3238afa990c2154a1a3"}],"shortTermGoalDefinitions":[{"id":"22e8902c79c4ee348fe5cf0da3dac656","activityDefinitions":[{"id":"22e8902c5fe1e3238afa990c2154b2b4"}]}]}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/plan-templates/11e8902c9e2908c69718f13503066bee \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \ \
-H 'If-Match: [object Object]' \
-d {"description":"Diabetes Template","status":"ACTIVE","healthConcernDefinitions":[{"id":"11e8901b64b1ca0b9c300d1ad3125a48","goalDefinitions":[{"id":"11e8902c79c4ee348fe5cf0da3dac545","activityDefinitions":[{"id":"11e8902c5fe1e3238afa990c2154a1a3"}],"shortTermGoalDefinitions":[{"id":"22e8902c79c4ee348fe5cf0da3dac656","activityDefinitions":[{"id":"22e8902c5fe1e3238afa990c2154b2b4"}]}]}],"activityDefinitions":[{"id":"11e8902c5fe1e3238afa990c2154a1a3"}]}],"goalDefinitions":[{"id":"11e8902c79c4ee348fe5cf0da3dac545","activityDefinitions":[{"id":"11e8902c5fe1e3238afa990c2154a1a3"}],"shortTermGoalDefinitions":[{"id":"22e8902c79c4ee348fe5cf0da3dac656","activityDefinitions":[{"id":"22e8902c5fe1e3238afa990c2154b2b4"}]}]}]}

Example response

{
  "id": "11e8902c9e2908c69718f13503066bee",
  "healthConcernDefinitions": [
    {
      "id": "11e8901b64b1ca0b9c300d1ad3125a48",
      "goalDefinitions": [
        {
          "id": "11e8902c79c4ee348fe5cf0da3dac545",
          "activityDefinitions": [
            {
              "id": "11e8902c5fe1e3238afa990c2154a1a3"
            }
          ],
          "shortTermGoalDefinitions": [
            {
              "id": "11e8902c79c4ee348fe5cf0da3dac545",
              "activityDefinitions": [
                {
                  "id": "11e8902c5fe1e3238afa990c2154a1a3"
                }
              ]
            }
          ]
        }
      ],
      "activityDefinitions": [
        {
          "id": "11e8902c5fe1e3238afa990c2154a1a3"
        }
      ]
    }
  ],
  "goalDefinitions": [
    {
      "id": "11e8902c79c4ee348fe5cf0da3dac545",
      "activityDefinitions": [
        {
          "id": "11e8902c5fe1e3238afa990c2154a1a3"
        }
      ],
      "shortTermGoalDefinitions": [
        {
          "id": "11e8902c79c4ee348fe5cf0da3dac545",
          "activityDefinitions": [
            {
              "id": "11e8902c5fe1e3238afa990c2154a1a3"
            }
          ]
        }
      ]
    }
  ],
  "createdAt": "2018-07-25T17:03:14.120Z",
  "updatedAt": "2018-07-25T17:03:14.120Z",
  "description": "Diabetes Template",
  "status": "ACTIVE"
}

PUT /plan-templates/{planTemplateId}

Updates a single plan template.

Parameters

Parameter In Type Required Default Description Accepted Values
If-Match header string true N/A The ETag of a specific version of a resource to match against. -
planTemplateId path string true N/A The ID of the plan template. -
body body putPlanTemplates true N/A No description -

Response Statuses

Status Meaning Description Schema
200 OK Update a Plan Template PlanTemplate
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error
409 Conflict Conflict Error
412 Precondition Failed Precondition Failed Error
415 Unsupported Media Type Unsupported Media Type Error
428 Precondition Required Precondition Required Error

Response Headers

Status Header Type Format Description
200 ETag string The ETag of a specific version of the plan template.

Retrieve a Single Plan Template

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/plan-templates/11e8902c9e2908c69718f13503066bee', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/plan-templates/11e8902c9e2908c69718f13503066bee \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "11e8902c9e2908c69718f13503066bee",
  "healthConcernDefinitions": [
    {
      "id": "11e8901b64b1ca0b9c300d1ad3125a48",
      "goalDefinitions": [
        {
          "id": "11e8902c79c4ee348fe5cf0da3dac545",
          "activityDefinitions": [
            {
              "id": "11e8902c5fe1e3238afa990c2154a1a3"
            }
          ],
          "shortTermGoalDefinitions": [
            {
              "id": "11e8902c79c4ee348fe5cf0da3dac545",
              "activityDefinitions": [
                {
                  "id": "11e8902c5fe1e3238afa990c2154a1a3"
                }
              ]
            }
          ]
        }
      ],
      "activityDefinitions": [
        {
          "id": "11e8902c5fe1e3238afa990c2154a1a3"
        }
      ]
    }
  ],
  "goalDefinitions": [
    {
      "id": "11e8902c79c4ee348fe5cf0da3dac545",
      "activityDefinitions": [
        {
          "id": "11e8902c5fe1e3238afa990c2154a1a3"
        }
      ],
      "shortTermGoalDefinitions": [
        {
          "id": "11e8902c79c4ee348fe5cf0da3dac545",
          "activityDefinitions": [
            {
              "id": "11e8902c5fe1e3238afa990c2154a1a3"
            }
          ]
        }
      ]
    }
  ],
  "createdAt": "2018-07-25T17:03:14.120Z",
  "updatedAt": "2018-07-25T17:03:14.120Z",
  "description": "Diabetes Template",
  "status": "ACTIVE"
}

GET /plan-templates/{planTemplateId}

Retrieves a single plan template by ID.

Parameters

Parameter In Type Required Default Description Accepted Values
planTemplateId path string true N/A The ID of the plan template. -

Response Statuses

Status Meaning Description Schema
200 OK Retrieve a Single Plan Template PlanTemplate
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Response Headers

Status Header Type Format Description
200 ETag string The ETag of a specific version of the plan template.

Consumer Template Items

Consumer template items are items on a person’s plan that match items on the specified template. Retrieving consumer template items allows you to more quickly determine whether a consumer has items on their plan that exist on a template. Additionally, it facilitates adding items from a template onto the person’s plan without creating duplicate plan items for the consumer.

Retrieve a List of Plan Template Items on a Consumer’s Plan

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/templates/11e8902c9e2908c69718f13503066bee/check', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/templates/11e8902c9e2908c69718f13503066bee/check \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "healthConcerns": [
    {
      "id": "11e8901dafad94f7a9b701d255a00ad0",
      "status": "RESOLVED",
      "code": {
        "text": "Type 1 Diabetes Mellitus"
      },
      "createdBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "createdAt": "2017-12-28T10:36:21.456Z",
      "healthConcernDefinitionId": "11e8902c79c4ee348fe5cf0da3dac545"
    }
  ],
  "goals": [
    {
      "id": "11e8591a4d5e569c8f673f9b3f4603ec",
      "description": "Pain maintained at or below acceptable pain rating",
      "status": "IN_PROGRESS",
      "createdAt": "2018-07-25T17:03:14.120Z",
      "createdBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "shortTermGoals": [
        {
          "id": "22e8902c79c4ee348fe5cf0da3dac656"
        }
      ],
      "longTermGoals": [
        {
          "id": "11e8902c79c4ee348fe5cf0da3dac545"
        }
      ],
      "healthConcerns": [
        {
          "id": "2f978977-4c67-448a-883b-5bbe8ca47bbd"
        }
      ],
      "goalDefinitionId": "11e8902c79c4ee348fe5cf0da3dac545"
    }
  ],
  "activities": [
    {
      "id": "11e8902c9e2908c69718f13503066bee",
      "description": "Daily weight monitoring using diary",
      "status": "ACCEPTED",
      "createdBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "createdAt": "2018-07-25T17:03:14.120Z",
      "healthConcerns": [
        {
          "id": "2f978977-4c67-448a-883b-5bbe8ca47bbd"
        }
      ],
      "goals": [
        {
          "id": "81d550d0-4569-49c5-bb08-28a8a5a34926"
        }
      ],
      "activityDefinitionId": "11e8902c79c4ee348fe5cf0da3dac545"
    }
  ]
}

GET /consumers/{consumerId}/templates/{planTemplateId}/check

Retrieves a list of items from a consumer’s plan that match the items contained in the specified template. Each list is primarily sorted by description in ascending alphabetic order and secondarily sorted by start or onset date in reverse chronological order. By default the API returns only items in the following statuses:
- Activities: The API returns activities in the following statuses by default: ACCEPTED, IN_PROGRESS, NOT_STARTED, PROPOSED, SCHEDULED, and SUSPENDED.
- Goals: The API returns goals in the following statuses by default: ACCEPTED, IN_PROGRESS, PLANNED, PROPOSED, and SUSPENDED.
- Health Concerns: The API returns health concerns in the following statuses by default: ACCEPTED, ACTIVE, PROPOSED, RELAPSE, and REMISSION.

Parameters

Parameter In Type Required Default Description Accepted Values
consumerId path string true N/A The ID of a HealtheIntent consumer. See Consumer API for more information. -
planTemplateId path string true N/A The ID of the plan template. -
activityStatus query array[string] false N/A Filters the response to only activities in the specified status. The following statuses are possible: ACCEPTED, IN_PROGRESS, NOT_STARTED, SCHEDULED, PROPOSED, and SUSPENDED. A query parameter must be provided to retrieve items in the following statuses: CANCELLED, COMPETED, IN_ERROR, and REJECTED. To retrieve any unique combination of statuses, a query parameter must be provided for each status. NOT_STARTED, IN_PROGRESS, COMPLETED, CANCELLED, SUSPENDED, SCHEDULED, PROPOSED, ACCEPTED, REJECTED, IN_ERROR
goalStatus query array[string] false N/A Filters the response to only goals in the specified status. The following statuses are possible: ACCEPTED, IN_PROGRESS, PLANNED, PROPOSED, and SUSPENDED. A query parameter must be provided to retrieve items in the following statuses: CANCELLED, COMPETED, IN_ERROR, and REJECTED. To retrieve any unique combination of statuses, a query parameter must be provided for each status. PLANNED, IN_PROGRESS, CANCELLED, IN_ERROR, PROPOSED, ACCEPTED, REJECTED, SUSPENDED, COMPLETED
healthConcernStatus query array[string] false N/A Filters the response to only health concerns in the specified status. The following statuses are possible: ACCEPTED, ACTIVE, PROPOSED, RELAPSE, and REMISSION. A query parameter must be provided to retrieve items in the following statuses: INACTIVE, RESOLVED, REJECTED, and IN_ERROR. To retrieve any unique combination of statuses, a query parameter must be provided for each status. IN_ERROR, ACCEPTED, ACTIVE, PROPOSED, REJECTED, RELAPSE, REMISSION, RESOLVED, INACTIVE

Response Statuses

Status Meaning Description Schema
200 OK Retrieve a List of Plan Template Items on a Consumer’s Plan ConsumerTemplate
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Activities

An activity is a planned action that one or more members of the care team carry out to support or reinforce the person’s overall health and wellness. Activities can be tasks that contribute to the achievement of goals and the elimination of health concerns or risks but may also exist irrespective of the two. Activities can vary in nature (whether they be physical, social, or educational, among other types) and may or may not have a set schedule in which they should be carried out. Activities can be tracked and managed by one or more individuals, and they can be related to other plan elements as well. See the following examples:

Additional comments can be provided about activities in notes to document progress, concerns, and other related information that may further explain or contribute to the meaning of the activity.

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/activities/11e8902c9e2908c69718f13503066bee/related-health-concerns/11e8901b64b1ca0b9c300d1ad3125a48', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/activities/11e8902c9e2908c69718f13503066bee/related-health-concerns/11e8901b64b1ca0b9c300d1ad3125a48 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /consumers/{consumerId}/activities/{activityId}/related-health-concerns/{healthConcernId}

Removes a related health concern from an activity.

Parameters

Parameter In Type Required Default Description Accepted Values
consumerId path string true N/A The ID of a HealtheIntent consumer. See Consumer API for more information. -
activityId path string true N/A The ID of the activity. -
healthConcernId path string true N/A The ID of the health concern. -

Response Statuses

Status Meaning Description Schema
204 No Content Remove a Related Health Concern From an Activity None
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Relate a Health Concern to an Activity

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/activities/11e8902c9e2908c69718f13503066bee/related-health-concerns/11e8901b64b1ca0b9c300d1ad3125a48', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/activities/11e8902c9e2908c69718f13503066bee/related-health-concerns/11e8901b64b1ca0b9c300d1ad3125a48 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

PUT /consumers/{consumerId}/activities/{activityId}/related-health-concerns/{healthConcernId}

Relates a health concern to an activity.

Parameters

Parameter In Type Required Default Description Accepted Values
consumerId path string true N/A The ID of a HealtheIntent consumer. See Consumer API for more information. -
activityId path string true N/A The ID of the activity. -
healthConcernId path string true N/A The ID of the health concern. -

Response Statuses

Status Meaning Description Schema
204 No Content The health concern is related to the activity. None
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Retrieve a List of Health Concerns for an Activity

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/activities/11e8902c9e2908c69718f13503066bee/related-health-concerns', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/activities/11e8902c9e2908c69718f13503066bee/related-health-concerns \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "11e8901b64b1ca0b9c300d1ad3125a48"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/activities/f3454f2a-665c-49d4-87db-8c167fete14b/related-health-concerns?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/activities/f3454f2a-665c-49d4-87db-8c167fete14b/related-health-concerns?offset=0&limit=20"
}

GET /consumers/{consumerId}/activities/{activityId}/related-health-concerns

Retrieves a list of the health concerns that are related to an activity.

Parameters

Parameter In Type Required Default Description Accepted Values
consumerId path string true N/A The ID of a HealtheIntent consumer. See Consumer API for more information. -
activityId path string true N/A The ID of the activity. -
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK Retrieve a List of Health Concerns for an Activity HealthConcernReferences
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/activities/11e8902c9e2908c69718f13503066bee/related-goals/11e8591a4d5e569c8f673f9b3f4603ec', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/activities/11e8902c9e2908c69718f13503066bee/related-goals/11e8591a4d5e569c8f673f9b3f4603ec \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /consumers/{consumerId}/activities/{activityId}/related-goals/{goalId}

Removes a related goal from an activity.

Parameters

Parameter In Type Required Default Description Accepted Values
consumerId path string true N/A The ID of a HealtheIntent consumer. See Consumer API for more information. -
activityId path string true N/A The ID of the activity. -
goalId path string true N/A The ID of the goal. -

Response Statuses

Status Meaning Description Schema
204 No Content Remove a Related Goal From an Activity None
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Relate a Goal to an Activity

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/activities/11e8902c9e2908c69718f13503066bee/related-goals/11e8591a4d5e569c8f673f9b3f4603ec', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/activities/11e8902c9e2908c69718f13503066bee/related-goals/11e8591a4d5e569c8f673f9b3f4603ec \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

PUT /consumers/{consumerId}/activities/{activityId}/related-goals/{goalId}

Relates a goal to an activity.

Parameters

Parameter In Type Required Default Description Accepted Values
consumerId path string true N/A The ID of a HealtheIntent consumer. See Consumer API for more information. -
activityId path string true N/A The ID of the activity. -
goalId path string true N/A The ID of the goal. -

Response Statuses

Status Meaning Description Schema
204 No Content The goal is related to the activity. None
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Retrieve a List of Goals for an Activity

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/activities/11e8902c9e2908c69718f13503066bee/goals', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/activities/11e8902c9e2908c69718f13503066bee/goals \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "11e8591a4d5e569c8f673f9b3f4603ec",
      "description": "Pain maintained at or below acceptable pain rating",
      "status": "IN_PROGRESS",
      "createdAt": "2018-07-25T17:03:14.120Z",
      "createdBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "shortTermGoals": [
        {
          "id": "22e8902c79c4ee348fe5cf0da3dac656"
        }
      ],
      "longTermGoals": [
        {
          "id": "11e8902c79c4ee348fe5cf0da3dac545"
        }
      ],
      "healthConcerns": [
        {
          "id": "2f978977-4c67-448a-883b-5bbe8ca47bbd"
        }
      ],
      "consumer": {
        "id": "d8454f2a-665c-49d4-87db-8c167feae10e"
      },
      "version": 1,
      "startDate": "2017-12-04",
      "dueDate": "2017-12-20",
      "statusReason": "Pain maintenance has been done",
      "progress": "PROGRESSING",
      "targets": [
        {
          "measureTypeDescription": "Diastolic Blood Pressure",
          "measureType": {
            "contextId": "6edf9160-1741-4538-97b1-cf0c2a557b16",
            "conceptAlias": "HYPERTENSION_CLIN_DIA"
          },
          "detail": {
            "range": {
              "high": "80",
              "low": "70",
              "unitDescription": "mmHg",
              "unit": {
                "contextId": "690aeffa-3029-c6aa-e053-5c2f47aa9044",
                "conceptAlias": "MILLIMETER_MERCURY_MM_HG_UOM"
              }
            }
          }
        },
        {
          "measureTypeDescription": "Systolic Blood Pressure",
          "measureType": {
            "contextId": "58c88d96-7ad0-4bfe-92d0-de52fca87642",
            "conceptAlias": "HYPERTENSION_CLIN_SYS"
          },
          "detail": {
            "range": {
              "high": "130",
              "low": "120",
              "unitDescription": "mmHg",
              "unit": {
                "contextId": "690aeffa-3029-c6aa-e053-5c2f47aa9044",
                "conceptAlias": "MILLIMETER_MERCURY_MM_HG_UOM"
              }
            }
          }
        }
      ],
      "goalDefinition": {
        "id": "11e8902c5fe1e3238afa990c2154a1a3",
        "text": "Cardiovascular Type 1"
      },
      "updatedAt": "2018-07-25T17:03:14.120Z",
      "updatedBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "expressedBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "owners": [
        {
          "type": "PERSONNEL",
          "reference": {
            "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
          }
        }
      ],
      "recentNotes": [
        {
          "text": "Patient is progressing.",
          "id": "11e8998c12b3bb9ebd7c1fbb695d35ec",
          "status": "ACTIVE",
          "createdBy": {
            "type": "PERSONNEL",
            "reference": {
              "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
            }
          },
          "createdAt": "2018-01-28T10:36:21.456Z",
          "updatedBy": {
            "type": "PERSONNEL",
            "reference": {
              "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
            }
          },
          "updatedAt": "2018-04-16T18:12:11.123Z"
        },
        {
          "text": "Patient is progressing.",
          "id": "11e8998c12b3bb9ebd7c1fbb695d35ec",
          "status": "ACTIVE",
          "createdBy": {
            "type": "PERSONNEL",
            "reference": {
              "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
            }
          },
          "createdAt": "2017-12-28T10:36:21.456Z",
          "updatedBy": {
            "type": "PERSONNEL",
            "reference": {
              "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
            }
          },
          "updatedAt": "2018-04-16T18:12:11.123Z"
        }
      ],
      "categories": [
        {
          "id": "11e818be2efb3d8f9c76653d4cc4a3f3",
          "text": "Running"
        },
        {
          "id": "11e831f1150a0ec3a8a26933567de562",
          "text": "Cardiovascular"
        }
      ],
      "disciplines": [
        {
          "id": "11c3a811c3900dc297c384c393c2bac2",
          "text": "Anesthesiology"
        },
        {
          "id": "11e8642c933ae8f48d534375f1bbef93",
          "text": "Bacteriology"
        }
      ],
      "sourceIdentifier": {
        "id": "0391d140-d06f-49bc-9f7f-be437e440333",
        "dataPartitionId": "4de3a1ab-5783-4e30-ba60-551ab1cf86fc"
      },
      "originatingSourceEncounter": {
        "id": "09920f12-006f-44za-019d-12kdk23094ee1",
        "dataPartitionId": "4de3a1ab-5783-4e30-ba60-551ab1cf86fc"
      },
      "updatedSourceEncounter": {
        "id": "09920f12-006f-44za-019d-12kdk23094ee2",
        "dataPartitionId": "4de3a1ab-5783-4e30-ba60-551ab1cf86fc"
      },
      "priority": 1,
      "sourcePlanTemplate": {
        "id": "11e8902c5fe1e3238afa990c2154a1a3"
      },
      "relatedActivitiesSummary": {
        "statuses": [
          {
            "status": "NOT_STARTED",
            "count": 1
          },
          {
            "status": "IN_PROGRESS",
            "count": 1
          },
          {
            "status": "COMPLETED",
            "count": 1
          },
          {
            "status": "CANCELLED",
            "count": 1
          },
          {
            "status": "SUSPENDED",
            "count": 1
          },
          {
            "status": "SCHEDULED",
            "count": 1
          },
          {
            "status": "PROPOSED",
            "count": 1
          },
          {
            "status": "ACCEPTED",
            "count": 1
          },
          {
            "status": "REJECTED",
            "count": 1
          },
          {
            "status": "IN_ERROR",
            "count": 0
          }
        ],
        "toalCount": 9
      },
      "statusHistory": [
        {
          "status": "IN_PROGRESS",
          "startAt": "2018-07-25T17:03:14.120Z",
          "updatedBy": {
            "type": "PERSONNEL",
            "reference": {
              "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
            }
          }
        }
      ],
      "progressHistory": [
        {
          "progress": "PROGRESSING",
          "startAt": "2018-07-25T17:03:14.120Z",
          "updatedBy": {
            "type": "PERSONNEL",
            "reference": {
              "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
            }
          }
        }
      ],
      "barriers": [
        {
          "id": "11e8901dafad94f7a9b701d255a00ad0",
          "status": "ACTIVE",
          "code": {
            "text": "Living in poverty"
          }
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/activities/11e8902c9e2908c69718f13503066bee/goals?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/activities/11e8902c9e2908c69718f13503066bee/goals?offset=0&limit=20"
}

GET /consumers/{consumerId}/activities/{activityId}/goals

Retrieves a list of the goals that are related to an activity.

Parameters

Parameter In Type Required Default Description Accepted Values
consumerId path string true N/A The ID of a HealtheIntent consumer. See Consumer API for more information. -
activityId path string true N/A The ID of the activity. -
status query array[string] false N/A Filters the response to only goals in the specified status. PLANNED, IN_PROGRESS, CANCELLED, IN_ERROR, PROPOSED, ACCEPTED, REJECTED, SUSPENDED, COMPLETED
dueDate query string false N/A Filters the response to goals with either a specific due date or a range of due dates. Specify a single date to retrieve goals with that due date. To specify a range, format the two dates separated by a comma and with a parenthesis or bracket on each side to denote an exclusive or inclusive endpoint, respectively. In other words, a parenthesis indicates that the date must be greater than or less than the date; a bracket indicates that the date must be greater than or equal to or lesser than or equal to the date. For example, [2017-01-01, 2018-01-01) is all dates on or after January 1, 2017, and before January 1, 2018. Additionally, leaving the start or end blank indicates the range is unbounded; for example, (,2018-01-01) means any date before January 1, 2018. All dates must be in ISO 8601 format YYYY-MM-DD. -
sourceId query array[string] false N/A The ID for the entity in the data partition. Required if dataPartitionId is provided. -
dataPartitionId query string false N/A The ID of the source data partition. Required if sourceId is provided. -
categoryId query array[string] false N/A The ID of the category. -
disciplineId query array[string] false N/A The ID of the discipline. -
progress query array[string] false N/A Filters the response to goals with the specified progress value. PROGRESSING, REGRESSING, AT_TARGET, ACHIEVED, NOT_ACHIEVED
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK Retrieve a List of Goals for an Activity Goals
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Update an Activity Note

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'If-Match' => {
  "type": "string"
}
} 

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/activities/11e8902c9e2908c69718f13503066bee/notes/11e8998c12b3bb9ebd7c1fbb695d35ec', headers: headers, body: {"text":"Patient is progressing.","updatedBy":{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}},"status":"ACTIVE"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/activities/11e8902c9e2908c69718f13503066bee/notes/11e8998c12b3bb9ebd7c1fbb695d35ec \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \ \
-H 'If-Match: [object Object]' \
-d {"text":"Patient is progressing.","updatedBy":{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}},"status":"ACTIVE"}

Example response

{
  "text": "Patient is progressing.",
  "id": "11e8998c12b3bb9ebd7c1fbb695d35ec",
  "version": 1,
  "status": "ACTIVE",
  "createdBy": {
    "type": "PERSONNEL",
    "reference": {
      "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
    }
  },
  "createdAt": "2017-12-28T10:36:21.456Z",
  "updatedBy": {
    "type": "PERSONNEL",
    "reference": {
      "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
    }
  },
  "updatedAt": "2018-04-16T18:12:11.123Z"
}

PUT /consumers/{consumerId}/activities/{activityId}/notes/{noteId}

Updates an activity note.

Parameters

Parameter In Type Required Default Description Accepted Values
If-Match header string true N/A The ETag must match the current version of the entity. -
consumerId path string true N/A The ID of a HealtheIntent consumer. See Consumer API for more information. -
activityId path string true N/A The ID of the activity. -
noteId path string true N/A The ID of the note. -
body body putConsumersConsumeridActivitiesActivityidNotes true N/A No description -

Response Statuses

Status Meaning Description Schema
200 OK Update an Activity Note Note
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error
412 Precondition Failed Precondition Failed Error
428 Precondition Required Precondition Required Error

Response Headers

Status Header Type Format Description
200 ETag string The ETag of a specific version of the activity note.

Retrieve a Single Activity Note

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/activities/11e8902c9e2908c69718f13503066bee/notes/11e8998c12b3bb9ebd7c1fbb695d35ec', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/activities/11e8902c9e2908c69718f13503066bee/notes/11e8998c12b3bb9ebd7c1fbb695d35ec \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "text": "Patient is progressing.",
  "id": "11e8998c12b3bb9ebd7c1fbb695d35ec",
  "version": 1,
  "status": "ACTIVE",
  "createdBy": {
    "type": "PERSONNEL",
    "reference": {
      "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
    }
  },
  "createdAt": "2017-12-28T10:36:21.456Z",
  "updatedBy": {
    "type": "PERSONNEL",
    "reference": {
      "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
    }
  },
  "updatedAt": "2018-04-16T18:12:11.123Z"
}

GET /consumers/{consumerId}/activities/{activityId}/notes/{noteId}

Retrieves a Single activity note.

Parameters

Parameter In Type Required Default Description Accepted Values
consumerId path string true N/A The ID of a HealtheIntent consumer. See Consumer API for more information. -
activityId path string true N/A The ID of the activity. -
noteId path string true N/A The ID of the note. -

Response Statuses

Status Meaning Description Schema
200 OK Retrieve a Single Activity Note Note
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Response Headers

Status Header Type Format Description
200 ETag string The ETag of a specific version of the activity note.

Create an Activity Note

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/activities/11e8902c9e2908c69718f13503066bee/notes', headers: headers, body: {"text":"Patient is progressing.","createdBy":{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/activities/11e8902c9e2908c69718f13503066bee/notes \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"text":"Patient is progressing.","createdBy":{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}}}

Example response

{
  "text": "Patient is progressing.",
  "id": "11e8998c12b3bb9ebd7c1fbb695d35ec",
  "version": 1,
  "status": "ACTIVE",
  "createdBy": {
    "type": "PERSONNEL",
    "reference": {
      "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
    }
  },
  "createdAt": "2017-12-28T10:36:21.456Z",
  "updatedBy": {
    "type": "PERSONNEL",
    "reference": {
      "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
    }
  },
  "updatedAt": "2018-04-16T18:12:11.123Z"
}

POST /consumers/{consumerId}/activities/{activityId}/notes

Creates an activity note.

Parameters

Parameter In Type Required Default Description Accepted Values
consumerId path string true N/A The ID of a HealtheIntent consumer. See Consumer API for more information. -
activityId path string true N/A The ID of the activity. -
body body postConsumersConsumeridActivitiesActivityidNotes true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created Create an Activity Note Note
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Response Headers

Status Header Type Format Description
201 ETag string The ETag of a specific version of the activity note.

Retrieve a List of Activity Notes

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/activities/11e8902c9e2908c69718f13503066bee/notes', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/activities/11e8902c9e2908c69718f13503066bee/notes \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "text": "Patient is progressing.",
      "id": "11e8998c12b3bb9ebd7c1fbb695d35ec",
      "version": 1,
      "status": "ACTIVE",
      "createdBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "createdAt": "2017-12-28T10:36:21.456Z",
      "updatedBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "updatedAt": "2018-04-16T18:12:11.123Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/activities/11e8902c9e2908c69718f13503066bee/notes?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/activities/11e8902c9e2908c69718f13503066bee/notes?offset=0&limit=20"
}

GET /consumers/{consumerId}/activities/{activityId}/notes

Retrieves a list of activity notes.

Parameters

Parameter In Type Required Default Description Accepted Values
consumerId path string true N/A The ID of a HealtheIntent consumer. See Consumer API for more information. -
activityId path string true N/A The ID of the activity. -
status query array[string] false N/A Filters the response by the note status. ACTIVE, IN_ERROR
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK Retrieve a List of Activity Notes Notes
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Update an Activity

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'If-Match' => {
  "type": "string"
}
} 

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/activities/11e8902c9e2908c69718f13503066bee', headers: headers, body: {"supportingInformation":"Daily weight monitoring using a diary can\n                    help you lead a healthy life. You can refer to the diary to see your weight trends and\n                    adjust your diet accordingly.","startDate":"2015-01-02","endDate":"2019-01-02","statusReason":"Activity has been accepted","description":"Daily weight monitoring using diary","status":"ACCEPTED","performers":[{"reference":{"id":"9cf249e6-9c5d-4d8a-a54a-46a6aabe3729"},"type":"PERSONNEL"}],"categories":[{"id":"11e818be2efb3d8f9c76653d4cc4a3f3"},{"id":"11e831f1150a0ec3a8a26933567de562"}],"disciplines":[{"id":"11c3a811c3900dc297c384c393c2bac2"},{"id":"11e8642c933ae8f48d534375f1bbef93"}],"supportingExternalReferences":[{"system":"https://dev.healthwise.net/services/services.content/v1/articles/","id":"4715932429582336"},{"system":"https://app.pluralsight.com/library/","id":"aws-developer-serverless-architecture-monitoring"}],"supportingReferences":[{"kind":"wellnessLearningModules#modules","id":"ecb8026a-64f9-11e8-adc0-fa7ae01bbebc"},{"kind":"education#content","id":"227ee4f0-6508-11e8-adc0-fa7ae01bbebc"}],"schedule":{"frequency":1,"period":1,"periodUnit":"D","duration":1,"durationUnit":"D"},"updatedBy":{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}},"targets":[{"measureTypeDescription":"Diastolic Blood Pressure","measureType":{"contextId":"6edf9160-1741-4538-97b1-cf0c2a557b16","conceptAlias":"HYPERTENSION_CLIN_DIA"},"detail":{"range":{"high":80,"low":70,"unitDescription":"mmHg","unit":{"contextId":"690aeffa-3029-c6aa-e053-5c2f47aa9044","conceptAlias":"MILLIMETER_MERCURY_MM_HG_UOM"}}}},{"measureTypeDescription":"Systolic Blood Pressure","measureType":{"contextId":"58c88d96-7ad0-4bfe-92d0-de52fca87642","conceptAlias":"HYPERTENSION_CLIN_SYS"},"detail":{"range":{"high":130,"low":120,"unitDescription":"mmHg","unit":{"contextId":"690aeffa-3029-c6aa-e053-5c2f47aa9044","conceptAlias":"MILLIMETER_MERCURY_MM_HG_UOM"}}}}],"updatedSourceEncounter":{"id":"11e8901b64b1ca0b9c300d1ad3125a48","dataPartitionId":"4de3a1ab-5783-4e30-ba60-551ab1cf86fc"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/activities/11e8902c9e2908c69718f13503066bee \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \ \
-H 'If-Match: [object Object]' \
-d {"supportingInformation":"Daily weight monitoring using a diary can\n                    help you lead a healthy life. You can refer to the diary to see your weight trends and\n                    adjust your diet accordingly.","startDate":"2015-01-02","endDate":"2019-01-02","statusReason":"Activity has been accepted","description":"Daily weight monitoring using diary","status":"ACCEPTED","performers":[{"reference":{"id":"9cf249e6-9c5d-4d8a-a54a-46a6aabe3729"},"type":"PERSONNEL"}],"categories":[{"id":"11e818be2efb3d8f9c76653d4cc4a3f3"},{"id":"11e831f1150a0ec3a8a26933567de562"}],"disciplines":[{"id":"11c3a811c3900dc297c384c393c2bac2"},{"id":"11e8642c933ae8f48d534375f1bbef93"}],"supportingExternalReferences":[{"system":"https://dev.healthwise.net/services/services.content/v1/articles/","id":"4715932429582336"},{"system":"https://app.pluralsight.com/library/","id":"aws-developer-serverless-architecture-monitoring"}],"supportingReferences":[{"kind":"wellnessLearningModules#modules","id":"ecb8026a-64f9-11e8-adc0-fa7ae01bbebc"},{"kind":"education#content","id":"227ee4f0-6508-11e8-adc0-fa7ae01bbebc"}],"schedule":{"frequency":1,"period":1,"periodUnit":"D","duration":1,"durationUnit":"D"},"updatedBy":{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}},"targets":[{"measureTypeDescription":"Diastolic Blood Pressure","measureType":{"contextId":"6edf9160-1741-4538-97b1-cf0c2a557b16","conceptAlias":"HYPERTENSION_CLIN_DIA"},"detail":{"range":{"high":80,"low":70,"unitDescription":"mmHg","unit":{"contextId":"690aeffa-3029-c6aa-e053-5c2f47aa9044","conceptAlias":"MILLIMETER_MERCURY_MM_HG_UOM"}}}},{"measureTypeDescription":"Systolic Blood Pressure","measureType":{"contextId":"58c88d96-7ad0-4bfe-92d0-de52fca87642","conceptAlias":"HYPERTENSION_CLIN_SYS"},"detail":{"range":{"high":130,"low":120,"unitDescription":"mmHg","unit":{"contextId":"690aeffa-3029-c6aa-e053-5c2f47aa9044","conceptAlias":"MILLIMETER_MERCURY_MM_HG_UOM"}}}}],"updatedSourceEncounter":{"id":"11e8901b64b1ca0b9c300d1ad3125a48","dataPartitionId":"4de3a1ab-5783-4e30-ba60-551ab1cf86fc"}}

Example response

{
  "id": "11e8902c9e2908c69718f13503066bee",
  "description": "Daily weight monitoring using diary",
  "status": "ACCEPTED",
  "createdBy": {
    "type": "PERSONNEL",
    "reference": {
      "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
    }
  },
  "createdAt": "2018-07-25T17:03:14.120Z",
  "healthConcerns": [
    {
      "id": "2f978977-4c67-448a-883b-5bbe8ca47bbd"
    }
  ],
  "goals": [
    {
      "id": "81d550d0-4569-49c5-bb08-28a8a5a34926"
    }
  ],
  "supportingInformation": "Daily weight monitoring using a diary can help you lead a healthy life.\n                    You can refer to the diary to see your weight trends and adjust your diet accordingly.",
  "version": 1,
  "startDate": "2015-01-02",
  "endDate": "2019-01-02",
  "schedule": {
    "frequency": 1,
    "period": 1,
    "periodUnit": "D",
    "duration": 1,
    "durationUnit": "D"
  },
  "targets": [
    {
      "measureTypeDescription": "Adult Wellness",
      "measureType": {
        "contextId": "6edf9160-1741-4538-97b1-cf0c2a557b16",
        "conceptAlias": "SCREENING_FOR_FUTURE_FALLS_RISK"
      },
      "detail": {
        "boolean": {
          "value": "TRUE"
        }
      }
    }
  ],
  "activityDefinition": {
    "id": "11e8902c5fe1e3238afa990c2154a1a3",
    "text": "Cardiovascular Type 1"
  },
  "recentNotes": [
    {
      "text": "Patient is progressing.",
      "id": "11e8998c12b3bb9ebd7c1fbb695d35ec",
      "status": "ACTIVE",
      "createdBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "createdAt": "2018-01-28T10:36:21.456Z",
      "updatedBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "updatedAt": "2018-04-16T18:12:11.123Z"
    },
    {
      "text": "Patient is progressing.",
      "id": "11e8998c12b3bb9ebd7c1fbb695d35ec",
      "status": "ACTIVE",
      "createdBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "createdAt": "2017-12-28T10:36:21.456Z",
      "updatedBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "updatedAt": "2018-04-16T18:12:11.123Z"
    }
  ],
  "categories": [
    {
      "id": "11e818be2efb3d8f9c76653d4cc4a3f3",
      "text": "Running"
    },
    {
      "id": "11e831f1150a0ec3a8a26933567de562",
      "text": "Cardiovascular"
    }
  ],
  "disciplines": [
    {
      "id": "11c3a811c3900dc297c384c393c2bac2",
      "text": "Anesthesiology"
    },
    {
      "id": "11e8642c933ae8f48d534375f1bbef93",
      "text": "Bacteriology"
    }
  ],
  "statusReason": "Activity has been accepted",
  "updatedAt": "2018-07-25T17:03:14.120Z",
  "updatedBy": {
    "type": "PERSONNEL",
    "reference": {
      "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
    }
  },
  "performers": [
    {
      "reference": {
        "id": "9cf249e6-9c5d-4d8a-a54a-46a6aabe3729"
      },
      "type": "PERSONNEL"
    }
  ],
  "sourceIdentifier": {
    "id": "0391d140-d06f-49bc-9f7f-be437e440333",
    "dataPartitionId": "4de3a1ab-5783-4e30-ba60-551ab1cf86fc"
  },
  "originatingSourceEncounter": {
    "id": "09920f12-006f-44za-019d-12kdk23094ee1",
    "dataPartitionId": "4de3a1ab-5783-4e30-ba60-551ab1cf86fc"
  },
  "updatedSourceEncounter": {
    "id": "09920f12-006f-44za-019d-12kdk23094ee2",
    "dataPartitionId": "4de3a1ab-5783-4e30-ba60-551ab1cf86fc"
  },
  "sourcePlanTemplate": {
    "id": "11e8902c5fe1e3238afa990c2154a1a3"
  },
  "supportingExternalReferences": [
    {
      "system": "https://dev.healthwise.net/services/services.content/v1/articles/",
      "id": "4715932429582336"
    },
    {
      "system": "https://app.pluralsight.com/library/",
      "id": "aws-developer-serverless-architecture-monitoring"
    }
  ],
  "supportingReferences": [
    {
      "kind": "wellnessLearningModules#modules",
      "id": "ecb8026a-64f9-11e8-adc0-fa7ae01bbebc"
    },
    {
      "kind": "education#content",
      "id": "227ee4f0-6508-11e8-adc0-fa7ae01bbebc"
    }
  ],
  "statusHistory": [
    {
      "status": "ACCEPTED",
      "startAt": "2018-07-25T17:03:14.120Z",
      "updatedBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      }
    }
  ]
}

PUT /consumers/{consumerId}/activities/{activityId}

Updates an activity.

Parameters

Parameter In Type Required Default Description Accepted Values
If-Match header string true N/A The specific version of the activity resource to update. -
consumerId path string true N/A The ID of a HealtheIntent consumer. See Consumer API for more information. -
activityId path string true N/A The ID of the activity. -
body body putConsumersConsumeridActivities true N/A No description -

Response Statuses

Status Meaning Description Schema
200 OK Update an Activity Activity
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error
412 Precondition Failed Precondition Failed Error
428 Precondition Required Precondition Required Error

Response Headers

Status Header Type Format Description
200 ETag string The ETag of a specific version of the activity.

Retrieve a Single Activity

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/activities/11e8902c9e2908c69718f13503066bee', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/activities/11e8902c9e2908c69718f13503066bee \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "11e8902c9e2908c69718f13503066bee",
  "description": "Daily weight monitoring using diary",
  "status": "ACCEPTED",
  "createdBy": {
    "type": "PERSONNEL",
    "reference": {
      "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
    }
  },
  "createdAt": "2018-07-25T17:03:14.120Z",
  "healthConcerns": [
    {
      "id": "2f978977-4c67-448a-883b-5bbe8ca47bbd"
    }
  ],
  "goals": [
    {
      "id": "81d550d0-4569-49c5-bb08-28a8a5a34926"
    }
  ],
  "supportingInformation": "Daily weight monitoring using a diary can help you lead a healthy life.\n                    You can refer to the diary to see your weight trends and adjust your diet accordingly.",
  "version": 1,
  "startDate": "2015-01-02",
  "endDate": "2019-01-02",
  "schedule": {
    "frequency": 1,
    "period": 1,
    "periodUnit": "D",
    "duration": 1,
    "durationUnit": "D"
  },
  "targets": [
    {
      "measureTypeDescription": "Adult Wellness",
      "measureType": {
        "contextId": "6edf9160-1741-4538-97b1-cf0c2a557b16",
        "conceptAlias": "SCREENING_FOR_FUTURE_FALLS_RISK"
      },
      "detail": {
        "boolean": {
          "value": "TRUE"
        }
      }
    }
  ],
  "activityDefinition": {
    "id": "11e8902c5fe1e3238afa990c2154a1a3",
    "text": "Cardiovascular Type 1"
  },
  "recentNotes": [
    {
      "text": "Patient is progressing.",
      "id": "11e8998c12b3bb9ebd7c1fbb695d35ec",
      "status": "ACTIVE",
      "createdBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "createdAt": "2018-01-28T10:36:21.456Z",
      "updatedBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "updatedAt": "2018-04-16T18:12:11.123Z"
    },
    {
      "text": "Patient is progressing.",
      "id": "11e8998c12b3bb9ebd7c1fbb695d35ec",
      "status": "ACTIVE",
      "createdBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "createdAt": "2017-12-28T10:36:21.456Z",
      "updatedBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "updatedAt": "2018-04-16T18:12:11.123Z"
    }
  ],
  "categories": [
    {
      "id": "11e818be2efb3d8f9c76653d4cc4a3f3",
      "text": "Running"
    },
    {
      "id": "11e831f1150a0ec3a8a26933567de562",
      "text": "Cardiovascular"
    }
  ],
  "disciplines": [
    {
      "id": "11c3a811c3900dc297c384c393c2bac2",
      "text": "Anesthesiology"
    },
    {
      "id": "11e8642c933ae8f48d534375f1bbef93",
      "text": "Bacteriology"
    }
  ],
  "statusReason": "Activity has been accepted",
  "updatedAt": "2018-07-25T17:03:14.120Z",
  "updatedBy": {
    "type": "PERSONNEL",
    "reference": {
      "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
    }
  },
  "performers": [
    {
      "reference": {
        "id": "9cf249e6-9c5d-4d8a-a54a-46a6aabe3729"
      },
      "type": "PERSONNEL"
    }
  ],
  "sourceIdentifier": {
    "id": "0391d140-d06f-49bc-9f7f-be437e440333",
    "dataPartitionId": "4de3a1ab-5783-4e30-ba60-551ab1cf86fc"
  },
  "originatingSourceEncounter": {
    "id": "09920f12-006f-44za-019d-12kdk23094ee1",
    "dataPartitionId": "4de3a1ab-5783-4e30-ba60-551ab1cf86fc"
  },
  "updatedSourceEncounter": {
    "id": "09920f12-006f-44za-019d-12kdk23094ee2",
    "dataPartitionId": "4de3a1ab-5783-4e30-ba60-551ab1cf86fc"
  },
  "sourcePlanTemplate": {
    "id": "11e8902c5fe1e3238afa990c2154a1a3"
  },
  "supportingExternalReferences": [
    {
      "system": "https://dev.healthwise.net/services/services.content/v1/articles/",
      "id": "4715932429582336"
    },
    {
      "system": "https://app.pluralsight.com/library/",
      "id": "aws-developer-serverless-architecture-monitoring"
    }
  ],
  "supportingReferences": [
    {
      "kind": "wellnessLearningModules#modules",
      "id": "ecb8026a-64f9-11e8-adc0-fa7ae01bbebc"
    },
    {
      "kind": "education#content",
      "id": "227ee4f0-6508-11e8-adc0-fa7ae01bbebc"
    }
  ],
  "statusHistory": [
    {
      "status": "ACCEPTED",
      "startAt": "2018-07-25T17:03:14.120Z",
      "updatedBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      }
    }
  ]
}

GET /consumers/{consumerId}/activities/{activityId}

Retrieves a single activity.

Parameters

Parameter In Type Required Default Description Accepted Values
consumerId path string true N/A The ID of a HealtheIntent consumer. See Consumer API for more information. -
activityId path string true N/A The ID of the activity. -

Response Statuses

Status Meaning Description Schema
200 OK Retrieve a Single Activity Activity
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Response Headers

Status Header Type Format Description
200 ETag string The ETag of a specific version of the activity.

Create an Activity

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/activities', headers: headers, body: {"supportingInformation":"Daily weight monitoring using a diary can\n                    help you lead a healthy life. You can refer to the diary to see your weight trends and\n                    adjust your diet accordingly.","startDate":"2015-01-02","endDate":"2019-01-02","statusReason":"Activity has been accepted","description":"Daily weight monitoring using diary","status":"ACCEPTED","performers":[{"reference":{"id":"9cf249e6-9c5d-4d8a-a54a-46a6aabe3729"},"type":"PERSONNEL"}],"categories":[{"id":"11e818be2efb3d8f9c76653d4cc4a3f3"},{"id":"11e831f1150a0ec3a8a26933567de562"}],"disciplines":[{"id":"11c3a811c3900dc297c384c393c2bac2"},{"id":"11e8642c933ae8f48d534375f1bbef93"}],"supportingExternalReferences":[{"system":"https://dev.healthwise.net/services/services.content/v1/articles/","id":"4715932429582336"},{"system":"https://app.pluralsight.com/library/","id":"aws-developer-serverless-architecture-monitoring"}],"supportingReferences":[{"kind":"wellnessLearningModules#modules","id":"ecb8026a-64f9-11e8-adc0-fa7ae01bbebc"},{"kind":"education#content","id":"227ee4f0-6508-11e8-adc0-fa7ae01bbebc"}],"schedule":{"frequency":1,"period":1,"periodUnit":"D","duration":1,"durationUnit":"D"},"createdBy":{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}},"activityDefinition":{"id":"11e8901b64b1ca0b9c300d1ad3125a48"},"sourceIdentifier":{"id":"0391d140-d06f-49bc-9f7f-be437e440333","dataPartitionId":"4de3a1ab-5783-4e30-ba60-551ab1cf86fc"},"targets":[{"measureTypeDescription":"Diastolic Blood Pressure","measureType":{"contextId":"6edf9160-1741-4538-97b1-cf0c2a557b16","conceptAlias":"HYPERTENSION_CLIN_DIA"},"detail":{"range":{"high":80,"low":70,"unitDescription":"mmHg","unit":{"contextId":"690aeffa-3029-c6aa-e053-5c2f47aa9044","conceptAlias":"MILLIMETER_MERCURY_MM_HG_UOM"}}}},{"measureTypeDescription":"Systolic Blood Pressure","measureType":{"contextId":"58c88d96-7ad0-4bfe-92d0-de52fca87642","conceptAlias":"HYPERTENSION_CLIN_SYS"},"detail":{"range":{"high":130,"low":120,"unitDescription":"mmHg","unit":{"contextId":"690aeffa-3029-c6aa-e053-5c2f47aa9044","conceptAlias":"MILLIMETER_MERCURY_MM_HG_UOM"}}}}],"originatingSourceEncounter":{"id":"11e8901b64b1ca0b9c300d1ad3125a48","dataPartitionId":"4de3a1ab-5783-4e30-ba60-551ab1cf86fc"},"sourcePlanTemplate":{"id":"11e8902c5fe1e3238afa990c2154a1a3"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/activities \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"supportingInformation":"Daily weight monitoring using a diary can\n                    help you lead a healthy life. You can refer to the diary to see your weight trends and\n                    adjust your diet accordingly.","startDate":"2015-01-02","endDate":"2019-01-02","statusReason":"Activity has been accepted","description":"Daily weight monitoring using diary","status":"ACCEPTED","performers":[{"reference":{"id":"9cf249e6-9c5d-4d8a-a54a-46a6aabe3729"},"type":"PERSONNEL"}],"categories":[{"id":"11e818be2efb3d8f9c76653d4cc4a3f3"},{"id":"11e831f1150a0ec3a8a26933567de562"}],"disciplines":[{"id":"11c3a811c3900dc297c384c393c2bac2"},{"id":"11e8642c933ae8f48d534375f1bbef93"}],"supportingExternalReferences":[{"system":"https://dev.healthwise.net/services/services.content/v1/articles/","id":"4715932429582336"},{"system":"https://app.pluralsight.com/library/","id":"aws-developer-serverless-architecture-monitoring"}],"supportingReferences":[{"kind":"wellnessLearningModules#modules","id":"ecb8026a-64f9-11e8-adc0-fa7ae01bbebc"},{"kind":"education#content","id":"227ee4f0-6508-11e8-adc0-fa7ae01bbebc"}],"schedule":{"frequency":1,"period":1,"periodUnit":"D","duration":1,"durationUnit":"D"},"createdBy":{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}},"activityDefinition":{"id":"11e8901b64b1ca0b9c300d1ad3125a48"},"sourceIdentifier":{"id":"0391d140-d06f-49bc-9f7f-be437e440333","dataPartitionId":"4de3a1ab-5783-4e30-ba60-551ab1cf86fc"},"targets":[{"measureTypeDescription":"Diastolic Blood Pressure","measureType":{"contextId":"6edf9160-1741-4538-97b1-cf0c2a557b16","conceptAlias":"HYPERTENSION_CLIN_DIA"},"detail":{"range":{"high":80,"low":70,"unitDescription":"mmHg","unit":{"contextId":"690aeffa-3029-c6aa-e053-5c2f47aa9044","conceptAlias":"MILLIMETER_MERCURY_MM_HG_UOM"}}}},{"measureTypeDescription":"Systolic Blood Pressure","measureType":{"contextId":"58c88d96-7ad0-4bfe-92d0-de52fca87642","conceptAlias":"HYPERTENSION_CLIN_SYS"},"detail":{"range":{"high":130,"low":120,"unitDescription":"mmHg","unit":{"contextId":"690aeffa-3029-c6aa-e053-5c2f47aa9044","conceptAlias":"MILLIMETER_MERCURY_MM_HG_UOM"}}}}],"originatingSourceEncounter":{"id":"11e8901b64b1ca0b9c300d1ad3125a48","dataPartitionId":"4de3a1ab-5783-4e30-ba60-551ab1cf86fc"},"sourcePlanTemplate":{"id":"11e8902c5fe1e3238afa990c2154a1a3"}}

Example response

{
  "id": "11e8902c9e2908c69718f13503066bee",
  "description": "Daily weight monitoring using diary",
  "status": "ACCEPTED",
  "createdBy": {
    "type": "PERSONNEL",
    "reference": {
      "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
    }
  },
  "createdAt": "2018-07-25T17:03:14.120Z",
  "healthConcerns": [
    {
      "id": "2f978977-4c67-448a-883b-5bbe8ca47bbd"
    }
  ],
  "goals": [
    {
      "id": "81d550d0-4569-49c5-bb08-28a8a5a34926"
    }
  ],
  "supportingInformation": "Daily weight monitoring using a diary can help you lead a healthy life.\n                    You can refer to the diary to see your weight trends and adjust your diet accordingly.",
  "version": 1,
  "startDate": "2015-01-02",
  "endDate": "2019-01-02",
  "schedule": {
    "frequency": 1,
    "period": 1,
    "periodUnit": "D",
    "duration": 1,
    "durationUnit": "D"
  },
  "targets": [
    {
      "measureTypeDescription": "Adult Wellness",
      "measureType": {
        "contextId": "6edf9160-1741-4538-97b1-cf0c2a557b16",
        "conceptAlias": "SCREENING_FOR_FUTURE_FALLS_RISK"
      },
      "detail": {
        "boolean": {
          "value": "TRUE"
        }
      }
    }
  ],
  "activityDefinition": {
    "id": "11e8902c5fe1e3238afa990c2154a1a3",
    "text": "Cardiovascular Type 1"
  },
  "recentNotes": [
    {
      "text": "Patient is progressing.",
      "id": "11e8998c12b3bb9ebd7c1fbb695d35ec",
      "status": "ACTIVE",
      "createdBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "createdAt": "2018-01-28T10:36:21.456Z",
      "updatedBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "updatedAt": "2018-04-16T18:12:11.123Z"
    },
    {
      "text": "Patient is progressing.",
      "id": "11e8998c12b3bb9ebd7c1fbb695d35ec",
      "status": "ACTIVE",
      "createdBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "createdAt": "2017-12-28T10:36:21.456Z",
      "updatedBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "updatedAt": "2018-04-16T18:12:11.123Z"
    }
  ],
  "categories": [
    {
      "id": "11e818be2efb3d8f9c76653d4cc4a3f3",
      "text": "Running"
    },
    {
      "id": "11e831f1150a0ec3a8a26933567de562",
      "text": "Cardiovascular"
    }
  ],
  "disciplines": [
    {
      "id": "11c3a811c3900dc297c384c393c2bac2",
      "text": "Anesthesiology"
    },
    {
      "id": "11e8642c933ae8f48d534375f1bbef93",
      "text": "Bacteriology"
    }
  ],
  "statusReason": "Activity has been accepted",
  "updatedAt": "2018-07-25T17:03:14.120Z",
  "updatedBy": {
    "type": "PERSONNEL",
    "reference": {
      "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
    }
  },
  "performers": [
    {
      "reference": {
        "id": "9cf249e6-9c5d-4d8a-a54a-46a6aabe3729"
      },
      "type": "PERSONNEL"
    }
  ],
  "sourceIdentifier": {
    "id": "0391d140-d06f-49bc-9f7f-be437e440333",
    "dataPartitionId": "4de3a1ab-5783-4e30-ba60-551ab1cf86fc"
  },
  "originatingSourceEncounter": {
    "id": "09920f12-006f-44za-019d-12kdk23094ee1",
    "dataPartitionId": "4de3a1ab-5783-4e30-ba60-551ab1cf86fc"
  },
  "updatedSourceEncounter": {
    "id": "09920f12-006f-44za-019d-12kdk23094ee2",
    "dataPartitionId": "4de3a1ab-5783-4e30-ba60-551ab1cf86fc"
  },
  "sourcePlanTemplate": {
    "id": "11e8902c5fe1e3238afa990c2154a1a3"
  },
  "supportingExternalReferences": [
    {
      "system": "https://dev.healthwise.net/services/services.content/v1/articles/",
      "id": "4715932429582336"
    },
    {
      "system": "https://app.pluralsight.com/library/",
      "id": "aws-developer-serverless-architecture-monitoring"
    }
  ],
  "supportingReferences": [
    {
      "kind": "wellnessLearningModules#modules",
      "id": "ecb8026a-64f9-11e8-adc0-fa7ae01bbebc"
    },
    {
      "kind": "education#content",
      "id": "227ee4f0-6508-11e8-adc0-fa7ae01bbebc"
    }
  ],
  "statusHistory": [
    {
      "status": "ACCEPTED",
      "startAt": "2018-07-25T17:03:14.120Z",
      "updatedBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      }
    }
  ]
}

POST /consumers/{consumerId}/activities

Creates a single activity.

Parameters

Parameter In Type Required Default Description Accepted Values
consumerId path string true N/A The ID of a HealtheIntent consumer. See Consumer API for more information. -
body body postConsumersConsumeridActivities true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created Create an Activity Activity
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Response Headers

Status Header Type Format Description
201 ETag string The ETag of a specific version of the activity.

Retrieve a List of Activities for a Consumer

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/activities', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/activities \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "11e8902c9e2908c69718f13503066bee",
      "description": "Daily weight monitoring using diary",
      "status": "ACCEPTED",
      "createdBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "createdAt": "2018-07-25T17:03:14.120Z",
      "healthConcerns": [
        {
          "id": "2f978977-4c67-448a-883b-5bbe8ca47bbd"
        }
      ],
      "goals": [
        {
          "id": "81d550d0-4569-49c5-bb08-28a8a5a34926"
        }
      ],
      "supportingInformation": "Daily weight monitoring using a diary can help you lead a healthy life.\n                    You can refer to the diary to see your weight trends and adjust your diet accordingly.",
      "version": 1,
      "startDate": "2015-01-02",
      "endDate": "2019-01-02",
      "schedule": {
        "frequency": 1,
        "period": 1,
        "periodUnit": "D",
        "duration": 1,
        "durationUnit": "D"
      },
      "targets": [
        {
          "measureTypeDescription": "Adult Wellness",
          "measureType": {
            "contextId": "6edf9160-1741-4538-97b1-cf0c2a557b16",
            "conceptAlias": "SCREENING_FOR_FUTURE_FALLS_RISK"
          },
          "detail": {
            "boolean": {
              "value": "TRUE"
            }
          }
        }
      ],
      "activityDefinition": {
        "id": "11e8902c5fe1e3238afa990c2154a1a3",
        "text": "Cardiovascular Type 1"
      },
      "recentNotes": [
        {
          "text": "Patient is progressing.",
          "id": "11e8998c12b3bb9ebd7c1fbb695d35ec",
          "status": "ACTIVE",
          "createdBy": {
            "type": "PERSONNEL",
            "reference": {
              "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
            }
          },
          "createdAt": "2018-01-28T10:36:21.456Z",
          "updatedBy": {
            "type": "PERSONNEL",
            "reference": {
              "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
            }
          },
          "updatedAt": "2018-04-16T18:12:11.123Z"
        },
        {
          "text": "Patient is progressing.",
          "id": "11e8998c12b3bb9ebd7c1fbb695d35ec",
          "status": "ACTIVE",
          "createdBy": {
            "type": "PERSONNEL",
            "reference": {
              "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
            }
          },
          "createdAt": "2017-12-28T10:36:21.456Z",
          "updatedBy": {
            "type": "PERSONNEL",
            "reference": {
              "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
            }
          },
          "updatedAt": "2018-04-16T18:12:11.123Z"
        }
      ],
      "categories": [
        {
          "id": "11e818be2efb3d8f9c76653d4cc4a3f3",
          "text": "Running"
        },
        {
          "id": "11e831f1150a0ec3a8a26933567de562",
          "text": "Cardiovascular"
        }
      ],
      "disciplines": [
        {
          "id": "11c3a811c3900dc297c384c393c2bac2",
          "text": "Anesthesiology"
        },
        {
          "id": "11e8642c933ae8f48d534375f1bbef93",
          "text": "Bacteriology"
        }
      ],
      "statusReason": "Activity has been accepted",
      "updatedAt": "2018-07-25T17:03:14.120Z",
      "updatedBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "performers": [
        {
          "reference": {
            "id": "9cf249e6-9c5d-4d8a-a54a-46a6aabe3729"
          },
          "type": "PERSONNEL"
        }
      ],
      "sourceIdentifier": {
        "id": "0391d140-d06f-49bc-9f7f-be437e440333",
        "dataPartitionId": "4de3a1ab-5783-4e30-ba60-551ab1cf86fc"
      },
      "originatingSourceEncounter": {
        "id": "09920f12-006f-44za-019d-12kdk23094ee1",
        "dataPartitionId": "4de3a1ab-5783-4e30-ba60-551ab1cf86fc"
      },
      "updatedSourceEncounter": {
        "id": "09920f12-006f-44za-019d-12kdk23094ee2",
        "dataPartitionId": "4de3a1ab-5783-4e30-ba60-551ab1cf86fc"
      },
      "sourcePlanTemplate": {
        "id": "11e8902c5fe1e3238afa990c2154a1a3"
      },
      "supportingExternalReferences": [
        {
          "system": "https://dev.healthwise.net/services/services.content/v1/articles/",
          "id": "4715932429582336"
        },
        {
          "system": "https://app.pluralsight.com/library/",
          "id": "aws-developer-serverless-architecture-monitoring"
        }
      ],
      "supportingReferences": [
        {
          "kind": "wellnessLearningModules#modules",
          "id": "ecb8026a-64f9-11e8-adc0-fa7ae01bbebc"
        },
        {
          "kind": "education#content",
          "id": "227ee4f0-6508-11e8-adc0-fa7ae01bbebc"
        }
      ],
      "statusHistory": [
        {
          "status": "ACCEPTED",
          "startAt": "2018-07-25T17:03:14.120Z",
          "updatedBy": {
            "type": "PERSONNEL",
            "reference": {
              "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
            }
          }
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/activities?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/activities?offset=0&limit=20"
}

GET /consumers/{consumerId}/activities

Retrieves a list of activities for a given consumer. The list is primarily sorted by description in ascending alphabetic order and secondarily sorted by start date in reverse chronological order.

Parameters

Parameter In Type Required Default Description Accepted Values
consumerId path string true N/A The ID of a HealtheIntent consumer. See Consumer API for more information. -
relatedGoals query string false N/A Filters the response to only activities with or without related goals. If true, only activities with related goals are included in the response. If false, only activities without related goals are included in the response. TRUE, FALSE
status query array[string] false N/A Filters the response to only activities in the specified status. NOT_STARTED, IN_PROGRESS, COMPLETED, CANCELLED, SUSPENDED, SCHEDULED, PROPOSED, ACCEPTED, REJECTED, IN_ERROR
activityDefinitionId query array[string] false N/A Filter the list of results to only those items that have the given activity definition ID. -
dataPartitionId query string false N/A The ID of the source data partition. Required if sourceId is provided. -
sourceId query array[string] false N/A The ID for the entity in the data partition. Required if dataPartitionId is provided. -
healthConcernId query string false N/A Filter the list to only those items that are related to the specified health concern ID. -
categoryId query array[string] false N/A The ID of the category. -
disciplineId query array[string] false N/A The ID of the discipline. -
supportingExternalReferenceSystem query string false N/A Filters the list of results to only those with external supporting references in the specified external system. The value for this parameter must be encoded if the system includes special characters, for example, https%3A%2F%2Fapp.pluralsight.com%2Flibrary for https://app.pluralsight.com/library. If supportingExternalReferenceSystem is specified, supportingExternalReferenceId must also be specified. -
supportingExternalReferenceId query string false N/A Filters the list of results to only those with the specified external supporting reference. If supportingExternalReferenceId is specified, supportingExternalReferenceSystem must also be specified. -
supportingReferenceKind query string false N/A Filters the list of results to only those with the specified kind of supporting reference. The value for this parameter must be encoded if the kind includes special characters, for example, welnessLearningModules%23modules for wellnessLearningModules#modules. If supportingReferenceKind is specified, supportingReferenceId must also be specified. -
supportingReferenceId query string false N/A Filters the list of results to only those with the specified supporting reference. If supportingReferenceId is specified, supportingReferenceKind must also be specified. -
id query array[string] false N/A Filters the list of results to only those with the specified activity ID. A single request can be sent for between 1 and 100 IDs. -
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK Retrieve a List of Activities for a Consumer Activities
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Retrieve the Status History for an Activity

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/activities/11e8902c9e2908c69718f13503066bee/status-history', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/activities/11e8902c9e2908c69718f13503066bee/status-history \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "status": "ACCEPTED",
      "startAt": "2018-07-25T17:03:14.120Z",
      "updatedBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/activities/11e8902c9e2908c69718f13503066bee/status-history?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/activities/11e8902c9e2908c69718f13503066bee/status-history?offset=0&limit=20"
}

GET /activities/{activityId}/status-history

Retrieves a list of the statuses that have been applied to an activity. The list is primarily sorted by start date in reverse chronological order.

Parameters

Parameter In Type Required Default Description Accepted Values
activityId path string true N/A The ID of the activity. -
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK Retrieve the Status History for an Activity ActivityStatusHistories
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

getConsumerActivities

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumer-activities',
  query: {
  'activityCreatedAt' => 'string'
}, headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumer-activities?activityCreatedAt=activityCreatedAt%3D%5B2020-02-02T01%3A00Z%2C2020-02-02T14%3A00Z%5D \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "consumer": {
        "id": "d8454f2a-665c-49d4-87db-8c167feae10e"
      },
      "activities": [
        {
          "id": "11e8902c9e2908c69718f13503066bee",
          "description": "Daily weight monitoring using diary",
          "status": "ACCEPTED",
          "supportingExternalReferences": [
            {
              "system": "https://dev.healthwise.net/services/services.content/v1/articles/",
              "id": "4715932429582336"
            },
            {
              "system": "https://app.pluralsight.com/library/",
              "id": "aws-developer-serverless-architecture-monitoring"
            }
          ],
          "supportingReferences": [
            {
              "kind": "wellnessLearningModules#modules",
              "id": "ecb8026a-64f9-11e8-adc0-fa7ae01bbebc"
            },
            {
              "kind": "education#content",
              "id": "227ee4f0-6508-11e8-adc0-fa7ae01bbebc"
            }
          ],
          "createdAt": "2018-07-25T17:03:14.120Z"
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers-activities?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers-activities?offset=0&limit=20"
}

GET /consumer-activities

Retrieve a list of consumers with the activities that match the specified search criteria.

Parameters

Parameter In Type Required Default Description Accepted Values
activityCreatedAt query string true N/A Filters the response to include consumers with activities that were -
status query array[string] false N/A Filters the response to only consumers that have activities in the specified status. NOT_STARTED, IN_PROGRESS, COMPLETED, CANCELLED, SUSPENDED, SCHEDULED, PROPOSED, ACCEPTED, REJECTED, IN_ERROR
supportingReferenceKind query string false N/A Filters the list of results to only consumers that have activities -
supportingExternalReferenceSystem query string false N/A Filters the list of results to only those with external supporting references in the specified external system. The value for this parameter must be encoded if the system includes special characters, for example, https%3A%2F%2Fapp.pluralsight.com%2Flibrary for https://app.pluralsight.com/library. If supportingExternalReferenceSystem is specified, supportingExternalReferenceId must also be specified. -
supportingExternalReferenceId query string false N/A Filters the list of results to only those with the specified external supporting reference. If supportingExternalReferenceId is specified, supportingExternalReferenceSystem must also be specified. -
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK Retrieve a list of consumers with the activities that match the specified search criteria. ConsumerActivities
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error
500 Internal Server Error Internal Server Error Error

Goals

A goal is a desired outcome toward which a care plan is directed. Goals can be achievements that will reduce or eliminate health concerns or risks but may also exist in the absence of health concerns. For example, a person might have a goal to improve their overall fitness level, which could be applicable to multiple health concerns or could be a general goal that the person continuously strives for irrespective of specific health concerns. Goals can be short-term (for example, to lose 10 pounds in 4 weeks) or long-term (for example, to remain free from drinking alcohol).

A short-term goal is established to progress toward a broader long-term goal. Because the concepts of long-term and short-term are relative to the patient, the caregiver, and the context of planning, no objective rules exist for when a goal should be short-term or long-term based on complexity or the time to completion. Instead, a goal is defined as short-term based on its relationship to a long-term goal. In other words, any goal can be a short-term goal as long as it is related to a long-term goal. When a caregiver establishes this relationship, the caregiver declares that the patient will make meaningful progress toward the associated long-term goal when the patient completes the short-term goal.

A long-term goal is a goal that is large enough in scope for the patient that a member of the care team decides to establish short-term goals for it to focus the patient’s care and progress toward the long-term goal. A caregiver may do this to outline the various milestones involved in completing a broader long-term goal or to focus the patient on achieving smaller, more easily attainable goals in the near term while still making progress toward a bigger overall goal.

Goals can be tracked and managed by one or more individuals and can be related to other plan elements as well. See the following examples:

Additional comments can be provided about goals in notes to document progress, concerns, or other related information that may further explain or contribute to the meaning of the goal.

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/goals/11e8591a4d5e569c8f673f9b3f4603ec/related-short-term-goals/11e8901b64b1ca0b9c300d1ad3125a48', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/goals/11e8591a4d5e569c8f673f9b3f4603ec/related-short-term-goals/11e8901b64b1ca0b9c300d1ad3125a48 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /consumers/{consumerId}/goals/{goalId}/related-short-term-goals/{shortTermGoalId}

Removes a related short-term goal from a goal.

Parameters

Parameter In Type Required Default Description Accepted Values
consumerId path string true N/A The ID of a HealtheIntent consumer. See Consumer API for more information. -
goalId path string true N/A The ID of the goal. -
shortTermGoalId path string true N/A The ID of the short-term goal. -

Response Statuses

Status Meaning Description Schema
204 No Content The short-term goal is no longer related to the goal. None
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Relate a Short-Term Goal to a Goal

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/goals/11e8591a4d5e569c8f673f9b3f4603ec/related-short-term-goals/11e8901b64b1ca0b9c300d1ad3125a48', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/goals/11e8591a4d5e569c8f673f9b3f4603ec/related-short-term-goals/11e8901b64b1ca0b9c300d1ad3125a48 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

PUT /consumers/{consumerId}/goals/{goalId}/related-short-term-goals/{shortTermGoalId}

Relates a short-term goal to a long-term goal. A short-term goal can only be related to a long-term goal. If the parent goal in the request is a short-term goal, a 400 HTTP status code (Bad Request) is sent.

Parameters

Parameter In Type Required Default Description Accepted Values
consumerId path string true N/A The ID of a HealtheIntent consumer. See Consumer API for more information. -
goalId path string true N/A The ID of the goal. -
shortTermGoalId path string true N/A The ID of the short-term goal. -

Response Statuses

Status Meaning Description Schema
204 No Content The short-term goal is related to the goal. None
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Retrieve a List of Short-Term Goals for a Goal

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/goals/11e8591a4d5e569c8f673f9b3f4603ec/short-term-goals', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/goals/11e8591a4d5e569c8f673f9b3f4603ec/short-term-goals \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "11e8591a4d5e569c8f673f9b3f4603ec",
      "description": "Pain maintained at or below acceptable pain rating",
      "status": "IN_PROGRESS",
      "createdAt": "2018-07-25T17:03:14.120Z",
      "createdBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "shortTermGoals": [
        {
          "id": "22e8902c79c4ee348fe5cf0da3dac656"
        }
      ],
      "longTermGoals": [
        {
          "id": "11e8902c79c4ee348fe5cf0da3dac545"
        }
      ],
      "healthConcerns": [
        {
          "id": "2f978977-4c67-448a-883b-5bbe8ca47bbd"
        }
      ],
      "consumer": {
        "id": "d8454f2a-665c-49d4-87db-8c167feae10e"
      },
      "version": 1,
      "startDate": "2017-12-04",
      "dueDate": "2017-12-20",
      "statusReason": "Pain maintenance has been done",
      "progress": "PROGRESSING",
      "targets": [
        {
          "measureTypeDescription": "Diastolic Blood Pressure",
          "measureType": {
            "contextId": "6edf9160-1741-4538-97b1-cf0c2a557b16",
            "conceptAlias": "HYPERTENSION_CLIN_DIA"
          },
          "detail": {
            "range": {
              "high": "80",
              "low": "70",
              "unitDescription": "mmHg",
              "unit": {
                "contextId": "690aeffa-3029-c6aa-e053-5c2f47aa9044",
                "conceptAlias": "MILLIMETER_MERCURY_MM_HG_UOM"
              }
            }
          }
        },
        {
          "measureTypeDescription": "Systolic Blood Pressure",
          "measureType": {
            "contextId": "58c88d96-7ad0-4bfe-92d0-de52fca87642",
            "conceptAlias": "HYPERTENSION_CLIN_SYS"
          },
          "detail": {
            "range": {
              "high": "130",
              "low": "120",
              "unitDescription": "mmHg",
              "unit": {
                "contextId": "690aeffa-3029-c6aa-e053-5c2f47aa9044",
                "conceptAlias": "MILLIMETER_MERCURY_MM_HG_UOM"
              }
            }
          }
        }
      ],
      "goalDefinition": {
        "id": "11e8902c5fe1e3238afa990c2154a1a3",
        "text": "Cardiovascular Type 1"
      },
      "updatedAt": "2018-07-25T17:03:14.120Z",
      "updatedBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "expressedBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "owners": [
        {
          "type": "PERSONNEL",
          "reference": {
            "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
          }
        }
      ],
      "recentNotes": [
        {
          "text": "Patient is progressing.",
          "id": "11e8998c12b3bb9ebd7c1fbb695d35ec",
          "status": "ACTIVE",
          "createdBy": {
            "type": "PERSONNEL",
            "reference": {
              "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
            }
          },
          "createdAt": "2018-01-28T10:36:21.456Z",
          "updatedBy": {
            "type": "PERSONNEL",
            "reference": {
              "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
            }
          },
          "updatedAt": "2018-04-16T18:12:11.123Z"
        },
        {
          "text": "Patient is progressing.",
          "id": "11e8998c12b3bb9ebd7c1fbb695d35ec",
          "status": "ACTIVE",
          "createdBy": {
            "type": "PERSONNEL",
            "reference": {
              "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
            }
          },
          "createdAt": "2017-12-28T10:36:21.456Z",
          "updatedBy": {
            "type": "PERSONNEL",
            "reference": {
              "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
            }
          },
          "updatedAt": "2018-04-16T18:12:11.123Z"
        }
      ],
      "categories": [
        {
          "id": "11e818be2efb3d8f9c76653d4cc4a3f3",
          "text": "Running"
        },
        {
          "id": "11e831f1150a0ec3a8a26933567de562",
          "text": "Cardiovascular"
        }
      ],
      "disciplines": [
        {
          "id": "11c3a811c3900dc297c384c393c2bac2",
          "text": "Anesthesiology"
        },
        {
          "id": "11e8642c933ae8f48d534375f1bbef93",
          "text": "Bacteriology"
        }
      ],
      "sourceIdentifier": {
        "id": "0391d140-d06f-49bc-9f7f-be437e440333",
        "dataPartitionId": "4de3a1ab-5783-4e30-ba60-551ab1cf86fc"
      },
      "originatingSourceEncounter": {
        "id": "09920f12-006f-44za-019d-12kdk23094ee1",
        "dataPartitionId": "4de3a1ab-5783-4e30-ba60-551ab1cf86fc"
      },
      "updatedSourceEncounter": {
        "id": "09920f12-006f-44za-019d-12kdk23094ee2",
        "dataPartitionId": "4de3a1ab-5783-4e30-ba60-551ab1cf86fc"
      },
      "priority": 1,
      "sourcePlanTemplate": {
        "id": "11e8902c5fe1e3238afa990c2154a1a3"
      },
      "relatedActivitiesSummary": {
        "statuses": [
          {
            "status": "NOT_STARTED",
            "count": 1
          },
          {
            "status": "IN_PROGRESS",
            "count": 1
          },
          {
            "status": "COMPLETED",
            "count": 1
          },
          {
            "status": "CANCELLED",
            "count": 1
          },
          {
            "status": "SUSPENDED",
            "count": 1
          },
          {
            "status": "SCHEDULED",
            "count": 1
          },
          {
            "status": "PROPOSED",
            "count": 1
          },
          {
            "status": "ACCEPTED",
            "count": 1
          },
          {
            "status": "REJECTED",
            "count": 1
          },
          {
            "status": "IN_ERROR",
            "count": 0
          }
        ],
        "toalCount": 9
      },
      "statusHistory": [
        {
          "status": "IN_PROGRESS",
          "startAt": "2018-07-25T17:03:14.120Z",
          "updatedBy": {
            "type": "PERSONNEL",
            "reference": {
              "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
            }
          }
        }
      ],
      "progressHistory": [
        {
          "progress": "PROGRESSING",
          "startAt": "2018-07-25T17:03:14.120Z",
          "updatedBy": {
            "type": "PERSONNEL",
            "reference": {
              "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
            }
          }
        }
      ],
      "barriers": [
        {
          "id": "11e8901dafad94f7a9b701d255a00ad0",
          "status": "ACTIVE",
          "code": {
            "text": "Living in poverty"
          }
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/goals/f3454f2a-665c-49d4-87db-8c167fete14b/short-term-goals?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/goals/f3454f2a-665c-49d4-87db-8c167fete14b/short-term-goals?offset=0&limit=20"
}

GET /consumers/{consumerId}/goals/{goalId}/short-term-goals

Retrieves a list of the short-term goals that are related to a goal.

Parameters

Parameter In Type Required Default Description Accepted Values
consumerId path string true N/A The ID of a HealtheIntent consumer. See Consumer API for more information. -
goalId path string true N/A The ID of the goal. -
status query array[string] false N/A Filters the response to only goals in the specified status. PLANNED, IN_PROGRESS, CANCELLED, IN_ERROR, PROPOSED, ACCEPTED, REJECTED, SUSPENDED, COMPLETED
categoryId query array[string] false N/A The ID of the category. -
disciplineId query array[string] false N/A The ID of the discipline. -
dueDate query string false N/A Filters the response to goals with either a specific due date or a range of due dates. Specify a single date to retrieve goals with that due date. To specify a range, format the two dates separated by a comma and with a parenthesis or bracket on each side to denote an exclusive or inclusive endpoint, respectively. In other words, a parenthesis indicates that the date must be greater than or less than the date; a bracket indicates that the date must be greater than or equal to or lesser than or equal to the date. For example, [2017-01-01, 2018-01-01) is all dates on or after January 1, 2017, and before January 1, 2018. Additionally, leaving the start or end blank indicates the range is unbounded; for example, (,2018-01-01) means any date before January 1, 2018. All dates must be in ISO 8601 format YYYY-MM-DD. -
progress query array[string] false N/A Filters the response to goals with the specified progress value. PROGRESSING, REGRESSING, AT_TARGET, ACHIEVED, NOT_ACHIEVED
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK Retrieve a List of Short-Term Goals for a Goal Goals
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/goals/11e8591a4d5e569c8f673f9b3f4603ec/related-health-concerns/11e8901b64b1ca0b9c300d1ad3125a48', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/goals/11e8591a4d5e569c8f673f9b3f4603ec/related-health-concerns/11e8901b64b1ca0b9c300d1ad3125a48 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /consumers/{consumerId}/goals/{goalId}/related-health-concerns/{healthConcernId}

Removes a related health concern from a goal.

Parameters

Parameter In Type Required Default Description Accepted Values
consumerId path string true N/A The ID of a HealtheIntent consumer. See Consumer API for more information. -
goalId path string true N/A The ID of the goal. -
healthConcernId path string true N/A The ID of the health concern. -

Response Statuses

Status Meaning Description Schema
204 No Content Remove a Related Health Concern From a Goal None
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Relate a Health Concern to a Goal

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/goals/11e8591a4d5e569c8f673f9b3f4603ec/related-health-concerns/11e8901b64b1ca0b9c300d1ad3125a48', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/goals/11e8591a4d5e569c8f673f9b3f4603ec/related-health-concerns/11e8901b64b1ca0b9c300d1ad3125a48 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

PUT /consumers/{consumerId}/goals/{goalId}/related-health-concerns/{healthConcernId}

Relates a health concern to a goal.

Parameters

Parameter In Type Required Default Description Accepted Values
consumerId path string true N/A The ID of a HealtheIntent consumer. See Consumer API for more information. -
goalId path string true N/A The ID of the goal. -
healthConcernId path string true N/A The ID of the health concern. -

Response Statuses

Status Meaning Description Schema
204 No Content The health concern is related to the goal. None
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Retrieve a List of Health Concerns for a Goal

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/goals/11e8591a4d5e569c8f673f9b3f4603ec/related-health-concerns', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/goals/11e8591a4d5e569c8f673f9b3f4603ec/related-health-concerns \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "11e8901b64b1ca0b9c300d1ad3125a48"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/goals/f3454f2a-665c-49d4-87db-8c167fete14b/related-health-concerns?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/goals/f3454f2a-665c-49d4-87db-8c167fete14b/related-health-concerns?offset=0&limit=20"
}

GET /consumers/{consumerId}/goals/{goalId}/related-health-concerns

Retrieves a list of the health concerns that are related to a goal.

Parameters

Parameter In Type Required Default Description Accepted Values
consumerId path string true N/A The ID of a HealtheIntent consumer. See Consumer API for more information. -
goalId path string true N/A The ID of the goal. -
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK Retrieve a List of Health Concerns for a Goal HealthConcernReferences
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Retrieve a List of Activities for a Goal

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/goals/11e8591a4d5e569c8f673f9b3f4603ec/activities', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/goals/11e8591a4d5e569c8f673f9b3f4603ec/activities \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "11e8902c9e2908c69718f13503066bee",
      "description": "Daily weight monitoring using diary",
      "status": "ACCEPTED",
      "createdBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "createdAt": "2018-07-25T17:03:14.120Z",
      "healthConcerns": [
        {
          "id": "2f978977-4c67-448a-883b-5bbe8ca47bbd"
        }
      ],
      "goals": [
        {
          "id": "81d550d0-4569-49c5-bb08-28a8a5a34926"
        }
      ],
      "supportingInformation": "Daily weight monitoring using a diary can help you lead a healthy life.\n                    You can refer to the diary to see your weight trends and adjust your diet accordingly.",
      "version": 1,
      "startDate": "2015-01-02",
      "endDate": "2019-01-02",
      "schedule": {
        "frequency": 1,
        "period": 1,
        "periodUnit": "D",
        "duration": 1,
        "durationUnit": "D"
      },
      "targets": [
        {
          "measureTypeDescription": "Adult Wellness",
          "measureType": {
            "contextId": "6edf9160-1741-4538-97b1-cf0c2a557b16",
            "conceptAlias": "SCREENING_FOR_FUTURE_FALLS_RISK"
          },
          "detail": {
            "boolean": {
              "value": "TRUE"
            }
          }
        }
      ],
      "activityDefinition": {
        "id": "11e8902c5fe1e3238afa990c2154a1a3",
        "text": "Cardiovascular Type 1"
      },
      "recentNotes": [
        {
          "text": "Patient is progressing.",
          "id": "11e8998c12b3bb9ebd7c1fbb695d35ec",
          "status": "ACTIVE",
          "createdBy": {
            "type": "PERSONNEL",
            "reference": {
              "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
            }
          },
          "createdAt": "2018-01-28T10:36:21.456Z",
          "updatedBy": {
            "type": "PERSONNEL",
            "reference": {
              "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
            }
          },
          "updatedAt": "2018-04-16T18:12:11.123Z"
        },
        {
          "text": "Patient is progressing.",
          "id": "11e8998c12b3bb9ebd7c1fbb695d35ec",
          "status": "ACTIVE",
          "createdBy": {
            "type": "PERSONNEL",
            "reference": {
              "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
            }
          },
          "createdAt": "2017-12-28T10:36:21.456Z",
          "updatedBy": {
            "type": "PERSONNEL",
            "reference": {
              "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
            }
          },
          "updatedAt": "2018-04-16T18:12:11.123Z"
        }
      ],
      "categories": [
        {
          "id": "11e818be2efb3d8f9c76653d4cc4a3f3",
          "text": "Running"
        },
        {
          "id": "11e831f1150a0ec3a8a26933567de562",
          "text": "Cardiovascular"
        }
      ],
      "disciplines": [
        {
          "id": "11c3a811c3900dc297c384c393c2bac2",
          "text": "Anesthesiology"
        },
        {
          "id": "11e8642c933ae8f48d534375f1bbef93",
          "text": "Bacteriology"
        }
      ],
      "statusReason": "Activity has been accepted",
      "updatedAt": "2018-07-25T17:03:14.120Z",
      "updatedBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "performers": [
        {
          "reference": {
            "id": "9cf249e6-9c5d-4d8a-a54a-46a6aabe3729"
          },
          "type": "PERSONNEL"
        }
      ],
      "sourceIdentifier": {
        "id": "0391d140-d06f-49bc-9f7f-be437e440333",
        "dataPartitionId": "4de3a1ab-5783-4e30-ba60-551ab1cf86fc"
      },
      "originatingSourceEncounter": {
        "id": "09920f12-006f-44za-019d-12kdk23094ee1",
        "dataPartitionId": "4de3a1ab-5783-4e30-ba60-551ab1cf86fc"
      },
      "updatedSourceEncounter": {
        "id": "09920f12-006f-44za-019d-12kdk23094ee2",
        "dataPartitionId": "4de3a1ab-5783-4e30-ba60-551ab1cf86fc"
      },
      "sourcePlanTemplate": {
        "id": "11e8902c5fe1e3238afa990c2154a1a3"
      },
      "supportingExternalReferences": [
        {
          "system": "https://dev.healthwise.net/services/services.content/v1/articles/",
          "id": "4715932429582336"
        },
        {
          "system": "https://app.pluralsight.com/library/",
          "id": "aws-developer-serverless-architecture-monitoring"
        }
      ],
      "supportingReferences": [
        {
          "kind": "wellnessLearningModules#modules",
          "id": "ecb8026a-64f9-11e8-adc0-fa7ae01bbebc"
        },
        {
          "kind": "education#content",
          "id": "227ee4f0-6508-11e8-adc0-fa7ae01bbebc"
        }
      ],
      "statusHistory": [
        {
          "status": "ACCEPTED",
          "startAt": "2018-07-25T17:03:14.120Z",
          "updatedBy": {
            "type": "PERSONNEL",
            "reference": {
              "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
            }
          }
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/goals/11e8a1694dd8ec288d589d6a17a6f9d6/activities?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/goals/11e8a1694dd8ec288d589d6a17a6f9d6/activities?offset=0&limit=20"
}

GET /consumers/{consumerId}/goals/{goalId}/activities

Retrieves a list of the activities that are related to a goal.

Parameters

Parameter In Type Required Default Description Accepted Values
consumerId path string true N/A The ID of a HealtheIntent consumer. See Consumer API for more information. -
goalId path string true N/A The ID of the goal. -
status query array[string] false N/A Filters the response to only activities in the specified status. NOT_STARTED, IN_PROGRESS, COMPLETED, CANCELLED, SUSPENDED, SCHEDULED, PROPOSED, ACCEPTED, REJECTED, IN_ERROR
dataPartitionId query string false N/A The ID of the source data partition. Required if sourceId is provided. -
sourceId query array[string] false N/A The ID for the entity in the data partition. Required if dataPartitionId is provided. -
categoryId query array[string] false N/A The ID of the category. -
disciplineId query array[string] false N/A The ID of the discipline. -
supportingExternalReferenceSystem query string false N/A Filters the list of results to only those with external supporting references in the specified external system. The value for this parameter must be encoded if the system includes special characters, for example, https%3A%2F%2Fapp.pluralsight.com%2Flibrary for https://app.pluralsight.com/library. If supportingExternalReferenceSystem is specified, supportingExternalReferenceId must also be specified. -
supportingExternalReferenceId query string false N/A Filters the list of results to only those with the specified external supporting reference. If supportingExternalReferenceId is specified, supportingExternalReferenceSystem must also be specified. -
supportingReferenceKind query string false N/A Filters the list of results to only those with the specified kind of supporting reference. The value for this parameter must be encoded if the kind includes special characters, for example, welnessLearningModules%23modules for wellnessLearningModules#modules. If supportingReferenceKind is specified, supportingReferenceId must also be specified. -
supportingReferenceId query string false N/A Filters the list of results to only those with the specified supporting reference. If supportingReferenceId is specified, supportingReferenceKind must also be specified. -
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK Retrieve a List of Activities for a Goal Activities
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Update a Goal Note

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'If-Match' => {
  "type": "string"
}
} 

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/goals/11e8591a4d5e569c8f673f9b3f4603ec/notes/11e8998c12b3bb9ebd7c1fbb695d35ec', headers: headers, body: {"text":"Patient is progressing.","updatedBy":{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}},"status":"ACTIVE"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/goals/11e8591a4d5e569c8f673f9b3f4603ec/notes/11e8998c12b3bb9ebd7c1fbb695d35ec \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \ \
-H 'If-Match: [object Object]' \
-d {"text":"Patient is progressing.","updatedBy":{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}},"status":"ACTIVE"}

Example response

{
  "text": "Patient is progressing.",
  "id": "11e8998c12b3bb9ebd7c1fbb695d35ec",
  "version": 1,
  "status": "ACTIVE",
  "createdBy": {
    "type": "PERSONNEL",
    "reference": {
      "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
    }
  },
  "createdAt": "2017-12-28T10:36:21.456Z",
  "updatedBy": {
    "type": "PERSONNEL",
    "reference": {
      "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
    }
  },
  "updatedAt": "2018-04-16T18:12:11.123Z"
}

PUT /consumers/{consumerId}/goals/{goalId}/notes/{noteId}

Updates a single goal note.

Parameters

Parameter In Type Required Default Description Accepted Values
If-Match header string true N/A The ETag must match the current version of the entity. -
consumerId path string true N/A The ID of a HealtheIntent consumer. See Consumer API for more information. -
goalId path string true N/A The ID of the goal. -
noteId path string true N/A The ID of the note. -
body body putConsumersConsumeridGoalsGoalidNotes true N/A No description -

Response Statuses

Status Meaning Description Schema
200 OK Update a Goal Note Note
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error
412 Precondition Failed Precondition Failed Error
428 Precondition Required Precondition Required Error

Response Headers

Status Header Type Format Description
200 ETag string The ETag of a specific version of the goal note.

Retrieve a Single Goal Note

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/goals/11e8591a4d5e569c8f673f9b3f4603ec/notes/11e8998c12b3bb9ebd7c1fbb695d35ec', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/goals/11e8591a4d5e569c8f673f9b3f4603ec/notes/11e8998c12b3bb9ebd7c1fbb695d35ec \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "text": "Patient is progressing.",
  "id": "11e8998c12b3bb9ebd7c1fbb695d35ec",
  "version": 1,
  "status": "ACTIVE",
  "createdBy": {
    "type": "PERSONNEL",
    "reference": {
      "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
    }
  },
  "createdAt": "2017-12-28T10:36:21.456Z",
  "updatedBy": {
    "type": "PERSONNEL",
    "reference": {
      "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
    }
  },
  "updatedAt": "2018-04-16T18:12:11.123Z"
}

GET /consumers/{consumerId}/goals/{goalId}/notes/{noteId}

Retrieves a single goal note.

Parameters

Parameter In Type Required Default Description Accepted Values
consumerId path string true N/A The ID of a HealtheIntent consumer. See Consumer API for more information. -
goalId path string true N/A The ID of the goal. -
noteId path string true N/A The ID of the note. -

Response Statuses

Status Meaning Description Schema
200 OK Retrieve a Single Goal Note Note
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Response Headers

Status Header Type Format Description
200 ETag string The ETag of a specific version of the goal note.

Create a Goal Note

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/goals/11e8591a4d5e569c8f673f9b3f4603ec/notes', headers: headers, body: {"text":"Patient is progressing.","createdBy":{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/goals/11e8591a4d5e569c8f673f9b3f4603ec/notes \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"text":"Patient is progressing.","createdBy":{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}}}

Example response

{
  "text": "Patient is progressing.",
  "id": "11e8998c12b3bb9ebd7c1fbb695d35ec",
  "version": 1,
  "status": "ACTIVE",
  "createdBy": {
    "type": "PERSONNEL",
    "reference": {
      "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
    }
  },
  "createdAt": "2017-12-28T10:36:21.456Z",
  "updatedBy": {
    "type": "PERSONNEL",
    "reference": {
      "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
    }
  },
  "updatedAt": "2018-04-16T18:12:11.123Z"
}

POST /consumers/{consumerId}/goals/{goalId}/notes

Creates a goal note.

Parameters

Parameter In Type Required Default Description Accepted Values
consumerId path string true N/A The ID of a HealtheIntent consumer. See Consumer API for more information. -
goalId path string true N/A The ID of the goal. -
body body postConsumersConsumeridGoalsGoalidNotes true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created Create a Goal Note Note
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Response Headers

Status Header Type Format Description
201 ETag string The ETag of a specific version of the goal note.

Retrieve a List of Goal Notes

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/goals/11e8591a4d5e569c8f673f9b3f4603ec/notes', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/goals/11e8591a4d5e569c8f673f9b3f4603ec/notes \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "text": "Patient is progressing.",
      "id": "11e8998c12b3bb9ebd7c1fbb695d35ec",
      "version": 1,
      "status": "ACTIVE",
      "createdBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "createdAt": "2017-12-28T10:36:21.456Z",
      "updatedBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "updatedAt": "2018-04-16T18:12:11.123Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/goals/11e8902c9e2908c69718f13503066bee/notes?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/goals/11e8902c9e2908c69718f13503066bee/notes?offset=0&limit=20"
}

GET /consumers/{consumerId}/goals/{goalId}/notes

Retrieves a list of goal notes.

Parameters

Parameter In Type Required Default Description Accepted Values
consumerId path string true N/A The ID of a HealtheIntent consumer. See Consumer API for more information. -
goalId path string true N/A The ID of the goal. -
status query array[string] false N/A Filters the response by the note status. ACTIVE, IN_ERROR
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK Retrieve a List of Goal Notes Notes
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Update a Goal

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'If-Match' => {
  "type": "string"
}
} 

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/goals/11e8591a4d5e569c8f673f9b3f4603ec', headers: headers, body: {"startDate":"2017-12-04","dueDate":"2017-12-20","statusReason":"Pain maintenance has been done","progress":"PROGRESSING","priority":1,"description":"Pain maintained at or below acceptable pain rating","status":"IN_PROGRESS","owners":[{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}}],"categories":[{"id":"11e818be2efb3d8f9c76653d4cc4a3f3"},{"id":"11e831f1150a0ec3a8a26933567de562"}],"disciplines":[{"id":"11c3a811c3900dc297c384c393c2bac2"},{"id":"11e8642c933ae8f48d534375f1bbef93"}],"expressedBy":{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}},"updatedBy":{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}},"targets":[{"measureTypeDescription":"Diastolic Blood Pressure","measureType":{"contextId":"6edf9160-1741-4538-97b1-cf0c2a557b16","conceptAlias":"HYPERTENSION_CLIN_DIA"},"detail":{"range":{"high":80,"low":70,"unitDescription":"mmHg","unit":{"contextId":"690aeffa-3029-c6aa-e053-5c2f47aa9044","conceptAlias":"MILLIMETER_MERCURY_MM_HG_UOM"}}}},{"measureTypeDescription":"Systolic Blood Pressure","measureType":{"contextId":"58c88d96-7ad0-4bfe-92d0-de52fca87642","conceptAlias":"HYPERTENSION_CLIN_SYS"},"detail":{"range":{"high":130,"low":120,"unitDescription":"mmHg","unit":{"contextId":"690aeffa-3029-c6aa-e053-5c2f47aa9044","conceptAlias":"MILLIMETER_MERCURY_MM_HG_UOM"}}}}],"progressStartAt":"2018-07-25T17:03:14.120Z","updatedSourceEncounter":{"id":"11e8901b64b1ca0b9c300d1ad3125a48","dataPartitionId":"4de3a1ab-5783-4e30-ba60-551ab1cf86fc"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/goals/11e8591a4d5e569c8f673f9b3f4603ec \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \ \
-H 'If-Match: [object Object]' \
-d {"startDate":"2017-12-04","dueDate":"2017-12-20","statusReason":"Pain maintenance has been done","progress":"PROGRESSING","priority":1,"description":"Pain maintained at or below acceptable pain rating","status":"IN_PROGRESS","owners":[{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}}],"categories":[{"id":"11e818be2efb3d8f9c76653d4cc4a3f3"},{"id":"11e831f1150a0ec3a8a26933567de562"}],"disciplines":[{"id":"11c3a811c3900dc297c384c393c2bac2"},{"id":"11e8642c933ae8f48d534375f1bbef93"}],"expressedBy":{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}},"updatedBy":{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}},"targets":[{"measureTypeDescription":"Diastolic Blood Pressure","measureType":{"contextId":"6edf9160-1741-4538-97b1-cf0c2a557b16","conceptAlias":"HYPERTENSION_CLIN_DIA"},"detail":{"range":{"high":80,"low":70,"unitDescription":"mmHg","unit":{"contextId":"690aeffa-3029-c6aa-e053-5c2f47aa9044","conceptAlias":"MILLIMETER_MERCURY_MM_HG_UOM"}}}},{"measureTypeDescription":"Systolic Blood Pressure","measureType":{"contextId":"58c88d96-7ad0-4bfe-92d0-de52fca87642","conceptAlias":"HYPERTENSION_CLIN_SYS"},"detail":{"range":{"high":130,"low":120,"unitDescription":"mmHg","unit":{"contextId":"690aeffa-3029-c6aa-e053-5c2f47aa9044","conceptAlias":"MILLIMETER_MERCURY_MM_HG_UOM"}}}}],"progressStartAt":"2018-07-25T17:03:14.120Z","updatedSourceEncounter":{"id":"11e8901b64b1ca0b9c300d1ad3125a48","dataPartitionId":"4de3a1ab-5783-4e30-ba60-551ab1cf86fc"}}

Example response

{
  "id": "11e8591a4d5e569c8f673f9b3f4603ec",
  "description": "Pain maintained at or below acceptable pain rating",
  "status": "IN_PROGRESS",
  "createdAt": "2018-07-25T17:03:14.120Z",
  "createdBy": {
    "type": "PERSONNEL",
    "reference": {
      "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
    }
  },
  "shortTermGoals": [
    {
      "id": "22e8902c79c4ee348fe5cf0da3dac656"
    }
  ],
  "longTermGoals": [
    {
      "id": "11e8902c79c4ee348fe5cf0da3dac545"
    }
  ],
  "healthConcerns": [
    {
      "id": "2f978977-4c67-448a-883b-5bbe8ca47bbd"
    }
  ],
  "consumer": {
    "id": "d8454f2a-665c-49d4-87db-8c167feae10e"
  },
  "version": 1,
  "startDate": "2017-12-04",
  "dueDate": "2017-12-20",
  "statusReason": "Pain maintenance has been done",
  "progress": "PROGRESSING",
  "targets": [
    {
      "measureTypeDescription": "Diastolic Blood Pressure",
      "measureType": {
        "contextId": "6edf9160-1741-4538-97b1-cf0c2a557b16",
        "conceptAlias": "HYPERTENSION_CLIN_DIA"
      },
      "detail": {
        "range": {
          "high": "80",
          "low": "70",
          "unitDescription": "mmHg",
          "unit": {
            "contextId": "690aeffa-3029-c6aa-e053-5c2f47aa9044",
            "conceptAlias": "MILLIMETER_MERCURY_MM_HG_UOM"
          }
        }
      }
    },
    {
      "measureTypeDescription": "Systolic Blood Pressure",
      "measureType": {
        "contextId": "58c88d96-7ad0-4bfe-92d0-de52fca87642",
        "conceptAlias": "HYPERTENSION_CLIN_SYS"
      },
      "detail": {
        "range": {
          "high": "130",
          "low": "120",
          "unitDescription": "mmHg",
          "unit": {
            "contextId": "690aeffa-3029-c6aa-e053-5c2f47aa9044",
            "conceptAlias": "MILLIMETER_MERCURY_MM_HG_UOM"
          }
        }
      }
    }
  ],
  "goalDefinition": {
    "id": "11e8902c5fe1e3238afa990c2154a1a3",
    "text": "Cardiovascular Type 1"
  },
  "updatedAt": "2018-07-25T17:03:14.120Z",
  "updatedBy": {
    "type": "PERSONNEL",
    "reference": {
      "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
    }
  },
  "expressedBy": {
    "type": "PERSONNEL",
    "reference": {
      "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
    }
  },
  "owners": [
    {
      "type": "PERSONNEL",
      "reference": {
        "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
      }
    }
  ],
  "recentNotes": [
    {
      "text": "Patient is progressing.",
      "id": "11e8998c12b3bb9ebd7c1fbb695d35ec",
      "status": "ACTIVE",
      "createdBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "createdAt": "2018-01-28T10:36:21.456Z",
      "updatedBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "updatedAt": "2018-04-16T18:12:11.123Z"
    },
    {
      "text": "Patient is progressing.",
      "id": "11e8998c12b3bb9ebd7c1fbb695d35ec",
      "status": "ACTIVE",
      "createdBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "createdAt": "2017-12-28T10:36:21.456Z",
      "updatedBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "updatedAt": "2018-04-16T18:12:11.123Z"
    }
  ],
  "categories": [
    {
      "id": "11e818be2efb3d8f9c76653d4cc4a3f3",
      "text": "Running"
    },
    {
      "id": "11e831f1150a0ec3a8a26933567de562",
      "text": "Cardiovascular"
    }
  ],
  "disciplines": [
    {
      "id": "11c3a811c3900dc297c384c393c2bac2",
      "text": "Anesthesiology"
    },
    {
      "id": "11e8642c933ae8f48d534375f1bbef93",
      "text": "Bacteriology"
    }
  ],
  "sourceIdentifier": {
    "id": "0391d140-d06f-49bc-9f7f-be437e440333",
    "dataPartitionId": "4de3a1ab-5783-4e30-ba60-551ab1cf86fc"
  },
  "originatingSourceEncounter": {
    "id": "09920f12-006f-44za-019d-12kdk23094ee1",
    "dataPartitionId": "4de3a1ab-5783-4e30-ba60-551ab1cf86fc"
  },
  "updatedSourceEncounter": {
    "id": "09920f12-006f-44za-019d-12kdk23094ee2",
    "dataPartitionId": "4de3a1ab-5783-4e30-ba60-551ab1cf86fc"
  },
  "priority": 1,
  "sourcePlanTemplate": {
    "id": "11e8902c5fe1e3238afa990c2154a1a3"
  },
  "relatedActivitiesSummary": {
    "statuses": [
      {
        "status": "NOT_STARTED",
        "count": 1
      },
      {
        "status": "IN_PROGRESS",
        "count": 1
      },
      {
        "status": "COMPLETED",
        "count": 1
      },
      {
        "status": "CANCELLED",
        "count": 1
      },
      {
        "status": "SUSPENDED",
        "count": 1
      },
      {
        "status": "SCHEDULED",
        "count": 1
      },
      {
        "status": "PROPOSED",
        "count": 1
      },
      {
        "status": "ACCEPTED",
        "count": 1
      },
      {
        "status": "REJECTED",
        "count": 1
      },
      {
        "status": "IN_ERROR",
        "count": 0
      }
    ],
    "toalCount": 9
  },
  "statusHistory": [
    {
      "status": "IN_PROGRESS",
      "startAt": "2018-07-25T17:03:14.120Z",
      "updatedBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      }
    }
  ],
  "progressHistory": [
    {
      "progress": "PROGRESSING",
      "startAt": "2018-07-25T17:03:14.120Z",
      "updatedBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      }
    }
  ],
  "barriers": [
    {
      "id": "11e8901dafad94f7a9b701d255a00ad0",
      "status": "ACTIVE",
      "code": {
        "text": "Living in poverty"
      }
    }
  ]
}

PUT /consumers/{consumerId}/goals/{goalId}

Updates a single goal.

Parameters

Parameter In Type Required Default Description Accepted Values
If-Match header string true N/A The specific version of the goal to update. -
consumerId path string true N/A The ID of a HealtheIntent consumer. See Consumer API for more information. -
goalId path string true N/A The ID of the goal. -
body body putConsumersConsumeridGoals true N/A No description -

Response Statuses

Status Meaning Description Schema
200 OK Update a Goal Goal
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error
412 Precondition Failed Precondition Failed Error
428 Precondition Required Precondition Required Error

Response Headers

Status Header Type Format Description
200 ETag string The ETag of a specific version of the goal.

Create a Goal

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/goals', headers: headers, body: {"startDate":"2017-12-04","dueDate":"2017-12-20","statusReason":"Pain maintenance has been done","progress":"PROGRESSING","priority":1,"description":"Pain maintained at or below acceptable pain rating","status":"IN_PROGRESS","owners":[{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}}],"categories":[{"id":"11e818be2efb3d8f9c76653d4cc4a3f3"},{"id":"11e831f1150a0ec3a8a26933567de562"}],"disciplines":[{"id":"11c3a811c3900dc297c384c393c2bac2"},{"id":"11e8642c933ae8f48d534375f1bbef93"}],"expressedBy":{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}},"createdBy":{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}},"goalDefinition":{"id":"11e8901b64b1ca0b9c300d1ad3125a48"},"sourceIdentifier":{"id":"0391d140-d06f-49bc-9f7f-be437e440333","dataPartitionId":"4de3a1ab-5783-4e30-ba60-551ab1cf86fc"},"targets":[{"measureTypeDescription":"Diastolic Blood Pressure","measureType":{"contextId":"6edf9160-1741-4538-97b1-cf0c2a557b16","conceptAlias":"HYPERTENSION_CLIN_DIA"},"detail":{"range":{"high":80,"low":70,"unitDescription":"mmHg","unit":{"contextId":"690aeffa-3029-c6aa-e053-5c2f47aa9044","conceptAlias":"MILLIMETER_MERCURY_MM_HG_UOM"}}}},{"measureTypeDescription":"Systolic Blood Pressure","measureType":{"contextId":"58c88d96-7ad0-4bfe-92d0-de52fca87642","conceptAlias":"HYPERTENSION_CLIN_SYS"},"detail":{"range":{"high":130,"low":120,"unitDescription":"mmHg","unit":{"contextId":"690aeffa-3029-c6aa-e053-5c2f47aa9044","conceptAlias":"MILLIMETER_MERCURY_MM_HG_UOM"}}}}],"originatingSourceEncounter":{"id":"11e8901b64b1ca0b9c300d1ad3125a48","dataPartitionId":"4de3a1ab-5783-4e30-ba60-551ab1cf86fc"},"progressStartAt":"2018-07-25T17:03:14.120Z","sourcePlanTemplate":{"id":"11e8902c5fe1e3238afa990c2154a1a3"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/goals \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"startDate":"2017-12-04","dueDate":"2017-12-20","statusReason":"Pain maintenance has been done","progress":"PROGRESSING","priority":1,"description":"Pain maintained at or below acceptable pain rating","status":"IN_PROGRESS","owners":[{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}}],"categories":[{"id":"11e818be2efb3d8f9c76653d4cc4a3f3"},{"id":"11e831f1150a0ec3a8a26933567de562"}],"disciplines":[{"id":"11c3a811c3900dc297c384c393c2bac2"},{"id":"11e8642c933ae8f48d534375f1bbef93"}],"expressedBy":{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}},"createdBy":{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}},"goalDefinition":{"id":"11e8901b64b1ca0b9c300d1ad3125a48"},"sourceIdentifier":{"id":"0391d140-d06f-49bc-9f7f-be437e440333","dataPartitionId":"4de3a1ab-5783-4e30-ba60-551ab1cf86fc"},"targets":[{"measureTypeDescription":"Diastolic Blood Pressure","measureType":{"contextId":"6edf9160-1741-4538-97b1-cf0c2a557b16","conceptAlias":"HYPERTENSION_CLIN_DIA"},"detail":{"range":{"high":80,"low":70,"unitDescription":"mmHg","unit":{"contextId":"690aeffa-3029-c6aa-e053-5c2f47aa9044","conceptAlias":"MILLIMETER_MERCURY_MM_HG_UOM"}}}},{"measureTypeDescription":"Systolic Blood Pressure","measureType":{"contextId":"58c88d96-7ad0-4bfe-92d0-de52fca87642","conceptAlias":"HYPERTENSION_CLIN_SYS"},"detail":{"range":{"high":130,"low":120,"unitDescription":"mmHg","unit":{"contextId":"690aeffa-3029-c6aa-e053-5c2f47aa9044","conceptAlias":"MILLIMETER_MERCURY_MM_HG_UOM"}}}}],"originatingSourceEncounter":{"id":"11e8901b64b1ca0b9c300d1ad3125a48","dataPartitionId":"4de3a1ab-5783-4e30-ba60-551ab1cf86fc"},"progressStartAt":"2018-07-25T17:03:14.120Z","sourcePlanTemplate":{"id":"11e8902c5fe1e3238afa990c2154a1a3"}}

Example response

{
  "id": "11e8591a4d5e569c8f673f9b3f4603ec",
  "description": "Pain maintained at or below acceptable pain rating",
  "status": "IN_PROGRESS",
  "createdAt": "2018-07-25T17:03:14.120Z",
  "createdBy": {
    "type": "PERSONNEL",
    "reference": {
      "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
    }
  },
  "shortTermGoals": [
    {
      "id": "22e8902c79c4ee348fe5cf0da3dac656"
    }
  ],
  "longTermGoals": [
    {
      "id": "11e8902c79c4ee348fe5cf0da3dac545"
    }
  ],
  "healthConcerns": [
    {
      "id": "2f978977-4c67-448a-883b-5bbe8ca47bbd"
    }
  ],
  "consumer": {
    "id": "d8454f2a-665c-49d4-87db-8c167feae10e"
  },
  "version": 1,
  "startDate": "2017-12-04",
  "dueDate": "2017-12-20",
  "statusReason": "Pain maintenance has been done",
  "progress": "PROGRESSING",
  "targets": [
    {
      "measureTypeDescription": "Diastolic Blood Pressure",
      "measureType": {
        "contextId": "6edf9160-1741-4538-97b1-cf0c2a557b16",
        "conceptAlias": "HYPERTENSION_CLIN_DIA"
      },
      "detail": {
        "range": {
          "high": "80",
          "low": "70",
          "unitDescription": "mmHg",
          "unit": {
            "contextId": "690aeffa-3029-c6aa-e053-5c2f47aa9044",
            "conceptAlias": "MILLIMETER_MERCURY_MM_HG_UOM"
          }
        }
      }
    },
    {
      "measureTypeDescription": "Systolic Blood Pressure",
      "measureType": {
        "contextId": "58c88d96-7ad0-4bfe-92d0-de52fca87642",
        "conceptAlias": "HYPERTENSION_CLIN_SYS"
      },
      "detail": {
        "range": {
          "high": "130",
          "low": "120",
          "unitDescription": "mmHg",
          "unit": {
            "contextId": "690aeffa-3029-c6aa-e053-5c2f47aa9044",
            "conceptAlias": "MILLIMETER_MERCURY_MM_HG_UOM"
          }
        }
      }
    }
  ],
  "goalDefinition": {
    "id": "11e8902c5fe1e3238afa990c2154a1a3",
    "text": "Cardiovascular Type 1"
  },
  "updatedAt": "2018-07-25T17:03:14.120Z",
  "updatedBy": {
    "type": "PERSONNEL",
    "reference": {
      "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
    }
  },
  "expressedBy": {
    "type": "PERSONNEL",
    "reference": {
      "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
    }
  },
  "owners": [
    {
      "type": "PERSONNEL",
      "reference": {
        "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
      }
    }
  ],
  "recentNotes": [
    {
      "text": "Patient is progressing.",
      "id": "11e8998c12b3bb9ebd7c1fbb695d35ec",
      "status": "ACTIVE",
      "createdBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "createdAt": "2018-01-28T10:36:21.456Z",
      "updatedBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "updatedAt": "2018-04-16T18:12:11.123Z"
    },
    {
      "text": "Patient is progressing.",
      "id": "11e8998c12b3bb9ebd7c1fbb695d35ec",
      "status": "ACTIVE",
      "createdBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "createdAt": "2017-12-28T10:36:21.456Z",
      "updatedBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "updatedAt": "2018-04-16T18:12:11.123Z"
    }
  ],
  "categories": [
    {
      "id": "11e818be2efb3d8f9c76653d4cc4a3f3",
      "text": "Running"
    },
    {
      "id": "11e831f1150a0ec3a8a26933567de562",
      "text": "Cardiovascular"
    }
  ],
  "disciplines": [
    {
      "id": "11c3a811c3900dc297c384c393c2bac2",
      "text": "Anesthesiology"
    },
    {
      "id": "11e8642c933ae8f48d534375f1bbef93",
      "text": "Bacteriology"
    }
  ],
  "sourceIdentifier": {
    "id": "0391d140-d06f-49bc-9f7f-be437e440333",
    "dataPartitionId": "4de3a1ab-5783-4e30-ba60-551ab1cf86fc"
  },
  "originatingSourceEncounter": {
    "id": "09920f12-006f-44za-019d-12kdk23094ee1",
    "dataPartitionId": "4de3a1ab-5783-4e30-ba60-551ab1cf86fc"
  },
  "updatedSourceEncounter": {
    "id": "09920f12-006f-44za-019d-12kdk23094ee2",
    "dataPartitionId": "4de3a1ab-5783-4e30-ba60-551ab1cf86fc"
  },
  "priority": 1,
  "sourcePlanTemplate": {
    "id": "11e8902c5fe1e3238afa990c2154a1a3"
  },
  "relatedActivitiesSummary": {
    "statuses": [
      {
        "status": "NOT_STARTED",
        "count": 1
      },
      {
        "status": "IN_PROGRESS",
        "count": 1
      },
      {
        "status": "COMPLETED",
        "count": 1
      },
      {
        "status": "CANCELLED",
        "count": 1
      },
      {
        "status": "SUSPENDED",
        "count": 1
      },
      {
        "status": "SCHEDULED",
        "count": 1
      },
      {
        "status": "PROPOSED",
        "count": 1
      },
      {
        "status": "ACCEPTED",
        "count": 1
      },
      {
        "status": "REJECTED",
        "count": 1
      },
      {
        "status": "IN_ERROR",
        "count": 0
      }
    ],
    "toalCount": 9
  },
  "statusHistory": [
    {
      "status": "IN_PROGRESS",
      "startAt": "2018-07-25T17:03:14.120Z",
      "updatedBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      }
    }
  ],
  "progressHistory": [
    {
      "progress": "PROGRESSING",
      "startAt": "2018-07-25T17:03:14.120Z",
      "updatedBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      }
    }
  ],
  "barriers": [
    {
      "id": "11e8901dafad94f7a9b701d255a00ad0",
      "status": "ACTIVE",
      "code": {
        "text": "Living in poverty"
      }
    }
  ]
}

POST /consumers/{consumerId}/goals

Creates a goal.

Parameters

Parameter In Type Required Default Description Accepted Values
consumerId path string true N/A The ID of a HealtheIntent consumer. See Consumer API for more information. -
body body postConsumersConsumeridGoals true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created Create a Goal Goal
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Response Headers

Status Header Type Format Description
201 ETag string The ETag of a specific version of the goal.

Retrieve a List of Goals for a Consumer

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/goals', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/goals \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "11e8591a4d5e569c8f673f9b3f4603ec",
      "description": "Pain maintained at or below acceptable pain rating",
      "status": "IN_PROGRESS",
      "createdAt": "2018-07-25T17:03:14.120Z",
      "createdBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "shortTermGoals": [
        {
          "id": "22e8902c79c4ee348fe5cf0da3dac656"
        }
      ],
      "longTermGoals": [
        {
          "id": "11e8902c79c4ee348fe5cf0da3dac545"
        }
      ],
      "healthConcerns": [
        {
          "id": "2f978977-4c67-448a-883b-5bbe8ca47bbd"
        }
      ],
      "consumer": {
        "id": "d8454f2a-665c-49d4-87db-8c167feae10e"
      },
      "version": 1,
      "startDate": "2017-12-04",
      "dueDate": "2017-12-20",
      "statusReason": "Pain maintenance has been done",
      "progress": "PROGRESSING",
      "targets": [
        {
          "measureTypeDescription": "Diastolic Blood Pressure",
          "measureType": {
            "contextId": "6edf9160-1741-4538-97b1-cf0c2a557b16",
            "conceptAlias": "HYPERTENSION_CLIN_DIA"
          },
          "detail": {
            "range": {
              "high": "80",
              "low": "70",
              "unitDescription": "mmHg",
              "unit": {
                "contextId": "690aeffa-3029-c6aa-e053-5c2f47aa9044",
                "conceptAlias": "MILLIMETER_MERCURY_MM_HG_UOM"
              }
            }
          }
        },
        {
          "measureTypeDescription": "Systolic Blood Pressure",
          "measureType": {
            "contextId": "58c88d96-7ad0-4bfe-92d0-de52fca87642",
            "conceptAlias": "HYPERTENSION_CLIN_SYS"
          },
          "detail": {
            "range": {
              "high": "130",
              "low": "120",
              "unitDescription": "mmHg",
              "unit": {
                "contextId": "690aeffa-3029-c6aa-e053-5c2f47aa9044",
                "conceptAlias": "MILLIMETER_MERCURY_MM_HG_UOM"
              }
            }
          }
        }
      ],
      "goalDefinition": {
        "id": "11e8902c5fe1e3238afa990c2154a1a3",
        "text": "Cardiovascular Type 1"
      },
      "updatedAt": "2018-07-25T17:03:14.120Z",
      "updatedBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "expressedBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "owners": [
        {
          "type": "PERSONNEL",
          "reference": {
            "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
          }
        }
      ],
      "recentNotes": [
        {
          "text": "Patient is progressing.",
          "id": "11e8998c12b3bb9ebd7c1fbb695d35ec",
          "status": "ACTIVE",
          "createdBy": {
            "type": "PERSONNEL",
            "reference": {
              "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
            }
          },
          "createdAt": "2018-01-28T10:36:21.456Z",
          "updatedBy": {
            "type": "PERSONNEL",
            "reference": {
              "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
            }
          },
          "updatedAt": "2018-04-16T18:12:11.123Z"
        },
        {
          "text": "Patient is progressing.",
          "id": "11e8998c12b3bb9ebd7c1fbb695d35ec",
          "status": "ACTIVE",
          "createdBy": {
            "type": "PERSONNEL",
            "reference": {
              "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
            }
          },
          "createdAt": "2017-12-28T10:36:21.456Z",
          "updatedBy": {
            "type": "PERSONNEL",
            "reference": {
              "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
            }
          },
          "updatedAt": "2018-04-16T18:12:11.123Z"
        }
      ],
      "categories": [
        {
          "id": "11e818be2efb3d8f9c76653d4cc4a3f3",
          "text": "Running"
        },
        {
          "id": "11e831f1150a0ec3a8a26933567de562",
          "text": "Cardiovascular"
        }
      ],
      "disciplines": [
        {
          "id": "11c3a811c3900dc297c384c393c2bac2",
          "text": "Anesthesiology"
        },
        {
          "id": "11e8642c933ae8f48d534375f1bbef93",
          "text": "Bacteriology"
        }
      ],
      "sourceIdentifier": {
        "id": "0391d140-d06f-49bc-9f7f-be437e440333",
        "dataPartitionId": "4de3a1ab-5783-4e30-ba60-551ab1cf86fc"
      },
      "originatingSourceEncounter": {
        "id": "09920f12-006f-44za-019d-12kdk23094ee1",
        "dataPartitionId": "4de3a1ab-5783-4e30-ba60-551ab1cf86fc"
      },
      "updatedSourceEncounter": {
        "id": "09920f12-006f-44za-019d-12kdk23094ee2",
        "dataPartitionId": "4de3a1ab-5783-4e30-ba60-551ab1cf86fc"
      },
      "priority": 1,
      "sourcePlanTemplate": {
        "id": "11e8902c5fe1e3238afa990c2154a1a3"
      },
      "relatedActivitiesSummary": {
        "statuses": [
          {
            "status": "NOT_STARTED",
            "count": 1
          },
          {
            "status": "IN_PROGRESS",
            "count": 1
          },
          {
            "status": "COMPLETED",
            "count": 1
          },
          {
            "status": "CANCELLED",
            "count": 1
          },
          {
            "status": "SUSPENDED",
            "count": 1
          },
          {
            "status": "SCHEDULED",
            "count": 1
          },
          {
            "status": "PROPOSED",
            "count": 1
          },
          {
            "status": "ACCEPTED",
            "count": 1
          },
          {
            "status": "REJECTED",
            "count": 1
          },
          {
            "status": "IN_ERROR",
            "count": 0
          }
        ],
        "toalCount": 9
      },
      "statusHistory": [
        {
          "status": "IN_PROGRESS",
          "startAt": "2018-07-25T17:03:14.120Z",
          "updatedBy": {
            "type": "PERSONNEL",
            "reference": {
              "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
            }
          }
        }
      ],
      "progressHistory": [
        {
          "progress": "PROGRESSING",
          "startAt": "2018-07-25T17:03:14.120Z",
          "updatedBy": {
            "type": "PERSONNEL",
            "reference": {
              "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
            }
          }
        }
      ],
      "barriers": [
        {
          "id": "11e8901dafad94f7a9b701d255a00ad0",
          "status": "ACTIVE",
          "code": {
            "text": "Living in poverty"
          }
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/goals?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/goals?offset=0&limit=20"
}

GET /consumers/{consumerId}/goals

Retrieves a list of goals for a given consumer. The list is primarily sorted by description in ascending alphabetic order and secondarily sorted by start date in reverse chronological order.

Parameters

Parameter In Type Required Default Description Accepted Values
consumerId path string true N/A The ID of a HealtheIntent consumer. See Consumer API for more information. -
status query array[string] false N/A Filters the response to only goals in the specified status. PLANNED, IN_PROGRESS, CANCELLED, IN_ERROR, PROPOSED, ACCEPTED, REJECTED, SUSPENDED, COMPLETED
goalDefinitionId query array[string] false N/A Filters the response to only goals that are associated with the specified goal definition ID. -
healthConcernId query string false N/A Filter the list to only those items that are related to the specified health concern ID. -
dueDate query string false N/A Filters the response to goals with either a specific due date or a range of due dates. Specify a single date to retrieve goals with that due date. To specify a range, format the two dates separated by a comma and with a parenthesis or bracket on each side to denote an exclusive or inclusive endpoint, respectively. In other words, a parenthesis indicates that the date must be greater than or less than the date; a bracket indicates that the date must be greater than or equal to or lesser than or equal to the date. For example, [2017-01-01, 2018-01-01) is all dates on or after January 1, 2017, and before January 1, 2018. Additionally, leaving the start or end blank indicates the range is unbounded; for example, (,2018-01-01) means any date before January 1, 2018. All dates must be in ISO 8601 format YYYY-MM-DD. -
sourceId query array[string] false N/A The ID for the entity in the data partition. Required if dataPartitionId is provided. -
dataPartitionId query string false N/A The ID of the source data partition. Required if sourceId is provided. -
categoryId query array[string] false N/A The ID of the category. -
disciplineId query array[string] false N/A The ID of the discipline. -
progress query array[string] false N/A Filters the response to goals with the specified progress value. PROGRESSING, REGRESSING, AT_TARGET, ACHIEVED, NOT_ACHIEVED
id query array[string] false N/A Filters the list of results to only those with the specified goal ID. A single request can be sent for between 1 and 100 IDs. -
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK Retrieve a List of Goals for a Consumer Goals
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Retrieve a Single Goal

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/goals/11e8591a4d5e569c8f673f9b3f4603ec', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/goals/11e8591a4d5e569c8f673f9b3f4603ec \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "11e8591a4d5e569c8f673f9b3f4603ec",
  "description": "Pain maintained at or below acceptable pain rating",
  "status": "IN_PROGRESS",
  "createdAt": "2018-07-25T17:03:14.120Z",
  "createdBy": {
    "type": "PERSONNEL",
    "reference": {
      "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
    }
  },
  "shortTermGoals": [
    {
      "id": "22e8902c79c4ee348fe5cf0da3dac656"
    }
  ],
  "longTermGoals": [
    {
      "id": "11e8902c79c4ee348fe5cf0da3dac545"
    }
  ],
  "healthConcerns": [
    {
      "id": "2f978977-4c67-448a-883b-5bbe8ca47bbd"
    }
  ],
  "consumer": {
    "id": "d8454f2a-665c-49d4-87db-8c167feae10e"
  },
  "version": 1,
  "startDate": "2017-12-04",
  "dueDate": "2017-12-20",
  "statusReason": "Pain maintenance has been done",
  "progress": "PROGRESSING",
  "targets": [
    {
      "measureTypeDescription": "Diastolic Blood Pressure",
      "measureType": {
        "contextId": "6edf9160-1741-4538-97b1-cf0c2a557b16",
        "conceptAlias": "HYPERTENSION_CLIN_DIA"
      },
      "detail": {
        "range": {
          "high": "80",
          "low": "70",
          "unitDescription": "mmHg",
          "unit": {
            "contextId": "690aeffa-3029-c6aa-e053-5c2f47aa9044",
            "conceptAlias": "MILLIMETER_MERCURY_MM_HG_UOM"
          }
        }
      }
    },
    {
      "measureTypeDescription": "Systolic Blood Pressure",
      "measureType": {
        "contextId": "58c88d96-7ad0-4bfe-92d0-de52fca87642",
        "conceptAlias": "HYPERTENSION_CLIN_SYS"
      },
      "detail": {
        "range": {
          "high": "130",
          "low": "120",
          "unitDescription": "mmHg",
          "unit": {
            "contextId": "690aeffa-3029-c6aa-e053-5c2f47aa9044",
            "conceptAlias": "MILLIMETER_MERCURY_MM_HG_UOM"
          }
        }
      }
    }
  ],
  "goalDefinition": {
    "id": "11e8902c5fe1e3238afa990c2154a1a3",
    "text": "Cardiovascular Type 1"
  },
  "updatedAt": "2018-07-25T17:03:14.120Z",
  "updatedBy": {
    "type": "PERSONNEL",
    "reference": {
      "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
    }
  },
  "expressedBy": {
    "type": "PERSONNEL",
    "reference": {
      "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
    }
  },
  "owners": [
    {
      "type": "PERSONNEL",
      "reference": {
        "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
      }
    }
  ],
  "recentNotes": [
    {
      "text": "Patient is progressing.",
      "id": "11e8998c12b3bb9ebd7c1fbb695d35ec",
      "status": "ACTIVE",
      "createdBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "createdAt": "2018-01-28T10:36:21.456Z",
      "updatedBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "updatedAt": "2018-04-16T18:12:11.123Z"
    },
    {
      "text": "Patient is progressing.",
      "id": "11e8998c12b3bb9ebd7c1fbb695d35ec",
      "status": "ACTIVE",
      "createdBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "createdAt": "2017-12-28T10:36:21.456Z",
      "updatedBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "updatedAt": "2018-04-16T18:12:11.123Z"
    }
  ],
  "categories": [
    {
      "id": "11e818be2efb3d8f9c76653d4cc4a3f3",
      "text": "Running"
    },
    {
      "id": "11e831f1150a0ec3a8a26933567de562",
      "text": "Cardiovascular"
    }
  ],
  "disciplines": [
    {
      "id": "11c3a811c3900dc297c384c393c2bac2",
      "text": "Anesthesiology"
    },
    {
      "id": "11e8642c933ae8f48d534375f1bbef93",
      "text": "Bacteriology"
    }
  ],
  "sourceIdentifier": {
    "id": "0391d140-d06f-49bc-9f7f-be437e440333",
    "dataPartitionId": "4de3a1ab-5783-4e30-ba60-551ab1cf86fc"
  },
  "originatingSourceEncounter": {
    "id": "09920f12-006f-44za-019d-12kdk23094ee1",
    "dataPartitionId": "4de3a1ab-5783-4e30-ba60-551ab1cf86fc"
  },
  "updatedSourceEncounter": {
    "id": "09920f12-006f-44za-019d-12kdk23094ee2",
    "dataPartitionId": "4de3a1ab-5783-4e30-ba60-551ab1cf86fc"
  },
  "priority": 1,
  "sourcePlanTemplate": {
    "id": "11e8902c5fe1e3238afa990c2154a1a3"
  },
  "relatedActivitiesSummary": {
    "statuses": [
      {
        "status": "NOT_STARTED",
        "count": 1
      },
      {
        "status": "IN_PROGRESS",
        "count": 1
      },
      {
        "status": "COMPLETED",
        "count": 1
      },
      {
        "status": "CANCELLED",
        "count": 1
      },
      {
        "status": "SUSPENDED",
        "count": 1
      },
      {
        "status": "SCHEDULED",
        "count": 1
      },
      {
        "status": "PROPOSED",
        "count": 1
      },
      {
        "status": "ACCEPTED",
        "count": 1
      },
      {
        "status": "REJECTED",
        "count": 1
      },
      {
        "status": "IN_ERROR",
        "count": 0
      }
    ],
    "toalCount": 9
  },
  "statusHistory": [
    {
      "status": "IN_PROGRESS",
      "startAt": "2018-07-25T17:03:14.120Z",
      "updatedBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      }
    }
  ],
  "progressHistory": [
    {
      "progress": "PROGRESSING",
      "startAt": "2018-07-25T17:03:14.120Z",
      "updatedBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      }
    }
  ],
  "barriers": [
    {
      "id": "11e8901dafad94f7a9b701d255a00ad0",
      "status": "ACTIVE",
      "code": {
        "text": "Living in poverty"
      }
    }
  ]
}

GET /goals/{goalId}

Retrieves a single goal.

Parameters

Parameter In Type Required Default Description Accepted Values
goalId path string true N/A The ID of the goal. -

Response Statuses

Status Meaning Description Schema
200 OK Retrieve a Single Goal Goal
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Response Headers

Status Header Type Format Description
200 ETag string The ETag of a specific version of the goal.

Retrieve List of Goals for a Tenant

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/goals', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/goals \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "11e8591a4d5e569c8f673f9b3f4603ec",
      "description": "Pain maintained at or below acceptable pain rating",
      "status": "IN_PROGRESS",
      "createdAt": "2018-07-25T17:03:14.120Z",
      "createdBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "shortTermGoals": [
        {
          "id": "22e8902c79c4ee348fe5cf0da3dac656"
        }
      ],
      "longTermGoals": [
        {
          "id": "11e8902c79c4ee348fe5cf0da3dac545"
        }
      ],
      "healthConcerns": [
        {
          "id": "2f978977-4c67-448a-883b-5bbe8ca47bbd"
        }
      ],
      "consumer": {
        "id": "d8454f2a-665c-49d4-87db-8c167feae10e"
      },
      "version": 1,
      "startDate": "2017-12-04",
      "dueDate": "2017-12-20",
      "statusReason": "Pain maintenance has been done",
      "progress": "PROGRESSING",
      "targets": [
        {
          "measureTypeDescription": "Diastolic Blood Pressure",
          "measureType": {
            "contextId": "6edf9160-1741-4538-97b1-cf0c2a557b16",
            "conceptAlias": "HYPERTENSION_CLIN_DIA"
          },
          "detail": {
            "range": {
              "high": "80",
              "low": "70",
              "unitDescription": "mmHg",
              "unit": {
                "contextId": "690aeffa-3029-c6aa-e053-5c2f47aa9044",
                "conceptAlias": "MILLIMETER_MERCURY_MM_HG_UOM"
              }
            }
          }
        },
        {
          "measureTypeDescription": "Systolic Blood Pressure",
          "measureType": {
            "contextId": "58c88d96-7ad0-4bfe-92d0-de52fca87642",
            "conceptAlias": "HYPERTENSION_CLIN_SYS"
          },
          "detail": {
            "range": {
              "high": "130",
              "low": "120",
              "unitDescription": "mmHg",
              "unit": {
                "contextId": "690aeffa-3029-c6aa-e053-5c2f47aa9044",
                "conceptAlias": "MILLIMETER_MERCURY_MM_HG_UOM"
              }
            }
          }
        }
      ],
      "goalDefinition": {
        "id": "11e8902c5fe1e3238afa990c2154a1a3",
        "text": "Cardiovascular Type 1"
      },
      "updatedAt": "2018-07-25T17:03:14.120Z",
      "updatedBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "expressedBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "owners": [
        {
          "type": "PERSONNEL",
          "reference": {
            "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
          }
        }
      ],
      "recentNotes": [
        {
          "text": "Patient is progressing.",
          "id": "11e8998c12b3bb9ebd7c1fbb695d35ec",
          "status": "ACTIVE",
          "createdBy": {
            "type": "PERSONNEL",
            "reference": {
              "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
            }
          },
          "createdAt": "2018-01-28T10:36:21.456Z",
          "updatedBy": {
            "type": "PERSONNEL",
            "reference": {
              "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
            }
          },
          "updatedAt": "2018-04-16T18:12:11.123Z"
        },
        {
          "text": "Patient is progressing.",
          "id": "11e8998c12b3bb9ebd7c1fbb695d35ec",
          "status": "ACTIVE",
          "createdBy": {
            "type": "PERSONNEL",
            "reference": {
              "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
            }
          },
          "createdAt": "2017-12-28T10:36:21.456Z",
          "updatedBy": {
            "type": "PERSONNEL",
            "reference": {
              "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
            }
          },
          "updatedAt": "2018-04-16T18:12:11.123Z"
        }
      ],
      "categories": [
        {
          "id": "11e818be2efb3d8f9c76653d4cc4a3f3",
          "text": "Running"
        },
        {
          "id": "11e831f1150a0ec3a8a26933567de562",
          "text": "Cardiovascular"
        }
      ],
      "disciplines": [
        {
          "id": "11c3a811c3900dc297c384c393c2bac2",
          "text": "Anesthesiology"
        },
        {
          "id": "11e8642c933ae8f48d534375f1bbef93",
          "text": "Bacteriology"
        }
      ],
      "sourceIdentifier": {
        "id": "0391d140-d06f-49bc-9f7f-be437e440333",
        "dataPartitionId": "4de3a1ab-5783-4e30-ba60-551ab1cf86fc"
      },
      "originatingSourceEncounter": {
        "id": "09920f12-006f-44za-019d-12kdk23094ee1",
        "dataPartitionId": "4de3a1ab-5783-4e30-ba60-551ab1cf86fc"
      },
      "updatedSourceEncounter": {
        "id": "09920f12-006f-44za-019d-12kdk23094ee2",
        "dataPartitionId": "4de3a1ab-5783-4e30-ba60-551ab1cf86fc"
      },
      "priority": 1,
      "sourcePlanTemplate": {
        "id": "11e8902c5fe1e3238afa990c2154a1a3"
      },
      "relatedActivitiesSummary": {
        "statuses": [
          {
            "status": "NOT_STARTED",
            "count": 1
          },
          {
            "status": "IN_PROGRESS",
            "count": 1
          },
          {
            "status": "COMPLETED",
            "count": 1
          },
          {
            "status": "CANCELLED",
            "count": 1
          },
          {
            "status": "SUSPENDED",
            "count": 1
          },
          {
            "status": "SCHEDULED",
            "count": 1
          },
          {
            "status": "PROPOSED",
            "count": 1
          },
          {
            "status": "ACCEPTED",
            "count": 1
          },
          {
            "status": "REJECTED",
            "count": 1
          },
          {
            "status": "IN_ERROR",
            "count": 0
          }
        ],
        "toalCount": 9
      },
      "statusHistory": [
        {
          "status": "IN_PROGRESS",
          "startAt": "2018-07-25T17:03:14.120Z",
          "updatedBy": {
            "type": "PERSONNEL",
            "reference": {
              "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
            }
          }
        }
      ],
      "progressHistory": [
        {
          "progress": "PROGRESSING",
          "startAt": "2018-07-25T17:03:14.120Z",
          "updatedBy": {
            "type": "PERSONNEL",
            "reference": {
              "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
            }
          }
        }
      ],
      "barriers": [
        {
          "id": "11e8901dafad94f7a9b701d255a00ad0",
          "status": "ACTIVE",
          "code": {
            "text": "Living in poverty"
          }
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/goals?dataPartitionId=4de3a1ab-5783-4e30-ba60-551ab1cf86fc&sourceId=0391d140-d06f-49bc-9f7f-be437e440333&offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/goals?dataPartitionId=4de3a1ab-5783-4e30-ba60-551ab1cf86fc&sourceId=0391d140-d06f-49bc-9f7f-be437e440333&offset=0&limit=20"
}

GET /goals

Retrieves a list of goals for a given tenant. The list is primarily sorted by description in ascending alphabetic order and secondarily sorted by start date in reverse chronological order.

Parameters

Parameter In Type Required Default Description Accepted Values
sourceId query array[string] false N/A The ID of the goal in the data partition. A single request can be sent for between 1 and 100 IDs. -
dataPartitionId query string false N/A The ID of the source data partition. -
id query array[string] false N/A Filters the list of results to only those with the specified goal ID. A single request can be sent for between 1 and 100 IDs. -
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK Retrieve List of Goals for a Tenant Goals
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Retrieve a List of Goal Barriers

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/goals/11e8591a4d5e569c8f673f9b3f4603ec/barriers', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/goals/11e8591a4d5e569c8f673f9b3f4603ec/barriers \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "11e8901dafad94f7a9b701d255a00ad0",
      "status": "ACTIVE",
      "version": 1,
      "barrierDefinition": {
        "id": "cf212bdb597f497eb454-0c0396cfe7ed",
        "text": "Living in poverty"
      },
      "code": {
        "text": "Living in poverty",
        "codings": [
          {
            "code": "11403006",
            "system": "2.16.840.1.113883.6.96"
          }
        ]
      },
      "concept": {
        "contextId": "37686A3F9C66452ABA66803ECC144344",
        "conceptAlias": "LIVING_IN_POVERTY_CLIN"
      },
      "createdAt": "2018-07-25T17:03:14.120Z",
      "createdBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "updatedAt": "2018-07-25T17:03:14.120Z",
      "updatedBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/goals/11e8902c9e2908c69718f13503066bee/barriers?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/goals/11e8902c9e2908c69718f13503066bee/barriers?offset=0&limit=20"
}

GET /goals/{goalId}/barriers

Retrieves a list of goal barriers.

Parameters

Parameter In Type Required Default Description Accepted Values
goalId path string true N/A The ID of the goal. -
status query array[string] false N/A Filters the retrieved barriers by status. INACTIVE, ACTIVE
barrierDefinitionId query array[string] false N/A The ID of the barrier definition. -
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK Retrieve a List of Goal Barriers Barriers
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Create a Goal Barrier

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/goals/11e8591a4d5e569c8f673f9b3f4603ec/barriers', headers: headers, body: {"barriers":[{"code":{"text":"Living in poverty","codings":[{"code":"11403006","system":"2.16.840.1.113883.6.96"}]},"status":"ACTIVE","concept":{"contextId":"37686A3F9C66452ABA66803ECC144344","conceptAlias":"LIVING_IN_POVERTY_CLIN"},"createdBy":{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}},"barrierDefinition":{"id":"11e8901b64b1ca0b9c300d1ad3125a48"}}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/goals/11e8591a4d5e569c8f673f9b3f4603ec/barriers \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"barriers":[{"code":{"text":"Living in poverty","codings":[{"code":"11403006","system":"2.16.840.1.113883.6.96"}]},"status":"ACTIVE","concept":{"contextId":"37686A3F9C66452ABA66803ECC144344","conceptAlias":"LIVING_IN_POVERTY_CLIN"},"createdBy":{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}},"barrierDefinition":{"id":"11e8901b64b1ca0b9c300d1ad3125a48"}}]}

Example response

{
  "items": [
    {
      "id": "11e8901dafad94f7a9b701d255a00ad0",
      "status": "ACTIVE",
      "version": 1,
      "barrierDefinition": {
        "id": "cf212bdb597f497eb454-0c0396cfe7ed",
        "text": "Living in poverty"
      },
      "code": {
        "text": "Living in poverty",
        "codings": [
          {
            "code": "11403006",
            "system": "2.16.840.1.113883.6.96"
          }
        ]
      },
      "concept": {
        "contextId": "37686A3F9C66452ABA66803ECC144344",
        "conceptAlias": "LIVING_IN_POVERTY_CLIN"
      },
      "createdAt": "2018-07-25T17:03:14.120Z",
      "createdBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "updatedAt": "2018-07-25T17:03:14.120Z",
      "updatedBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      }
    }
  ],
  "totalResults": 1
}

POST /goals/{goalId}/barriers

Creates a goal barrier.

Parameters

Parameter In Type Required Default Description Accepted Values
goalId path string true N/A The ID of the goal. -
body body postGoalsGoalidBarriers true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created Create a Goal Barrier BarrierList
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
404 Not Found Not Found Error

Update a Goal Barrier

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'If-Match' => {
  "type": "string"
}
} 

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/goals/11e8591a4d5e569c8f673f9b3f4603ec/barriers/11e8998c12b3bb9ebd7c1fbb695d35ec', headers: headers, body: {"code":{"text":"Living in poverty","codings":[{"code":"11403006","system":"2.16.840.1.113883.6.96"}]},"status":"ACTIVE","concept":{"contextId":"37686A3F9C66452ABA66803ECC144344","conceptAlias":"LIVING_IN_POVERTY_CLIN"},"updatedBy":{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/goals/11e8591a4d5e569c8f673f9b3f4603ec/barriers/11e8998c12b3bb9ebd7c1fbb695d35ec \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \ \
-H 'If-Match: [object Object]' \
-d {"code":{"text":"Living in poverty","codings":[{"code":"11403006","system":"2.16.840.1.113883.6.96"}]},"status":"ACTIVE","concept":{"contextId":"37686A3F9C66452ABA66803ECC144344","conceptAlias":"LIVING_IN_POVERTY_CLIN"},"updatedBy":{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}}}

Example response

{
  "id": "11e8901dafad94f7a9b701d255a00ad0",
  "status": "ACTIVE",
  "version": 1,
  "barrierDefinition": {
    "id": "cf212bdb597f497eb454-0c0396cfe7ed",
    "text": "Living in poverty"
  },
  "code": {
    "text": "Living in poverty",
    "codings": [
      {
        "code": "11403006",
        "system": "2.16.840.1.113883.6.96"
      }
    ]
  },
  "concept": {
    "contextId": "37686A3F9C66452ABA66803ECC144344",
    "conceptAlias": "LIVING_IN_POVERTY_CLIN"
  },
  "createdAt": "2018-07-25T17:03:14.120Z",
  "createdBy": {
    "type": "PERSONNEL",
    "reference": {
      "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
    }
  },
  "updatedAt": "2018-07-25T17:03:14.120Z",
  "updatedBy": {
    "type": "PERSONNEL",
    "reference": {
      "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
    }
  }
}

PUT /goals/{goalId}/barriers/{barrierId}

Updates a single goal barrier.

Parameters

Parameter In Type Required Default Description Accepted Values
If-Match header string true N/A The ETag must match the current version of the entity. -
goalId path string true N/A The ID of the goal. -
barrierId path string true N/A The ID of a barrier. -
body body putGoalsGoalidBarriers true N/A No description -

Response Statuses

Status Meaning Description Schema
200 OK Update a Goal Barrier Barrier
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error
412 Precondition Failed Precondition Failed Error
428 Precondition Required Precondition Required Error

Response Headers

Status Header Type Format Description
200 ETag string The ETag of a specific version of the goal barrier.

Retrieve a Single Goal Barrier

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/goals/11e8591a4d5e569c8f673f9b3f4603ec/barriers/11e8998c12b3bb9ebd7c1fbb695d35ec', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/goals/11e8591a4d5e569c8f673f9b3f4603ec/barriers/11e8998c12b3bb9ebd7c1fbb695d35ec \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "11e8901dafad94f7a9b701d255a00ad0",
  "status": "ACTIVE",
  "version": 1,
  "barrierDefinition": {
    "id": "cf212bdb597f497eb454-0c0396cfe7ed",
    "text": "Living in poverty"
  },
  "code": {
    "text": "Living in poverty",
    "codings": [
      {
        "code": "11403006",
        "system": "2.16.840.1.113883.6.96"
      }
    ]
  },
  "concept": {
    "contextId": "37686A3F9C66452ABA66803ECC144344",
    "conceptAlias": "LIVING_IN_POVERTY_CLIN"
  },
  "createdAt": "2018-07-25T17:03:14.120Z",
  "createdBy": {
    "type": "PERSONNEL",
    "reference": {
      "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
    }
  },
  "updatedAt": "2018-07-25T17:03:14.120Z",
  "updatedBy": {
    "type": "PERSONNEL",
    "reference": {
      "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
    }
  }
}

GET /goals/{goalId}/barriers/{barrierId}

Retrieves a single goal barrier.

Parameters

Parameter In Type Required Default Description Accepted Values
goalId path string true N/A The ID of the goal. -
barrierId path string true N/A The ID of a barrier. -

Response Statuses

Status Meaning Description Schema
200 OK Retrieve a Single Goal Barrier Barrier
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Response Headers

Status Header Type Format Description
200 ETag string The ETag of a specific version of the goal barrier.

Retrieve the Status History for a Goal

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/goals/11e8591a4d5e569c8f673f9b3f4603ec/status-history', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/goals/11e8591a4d5e569c8f673f9b3f4603ec/status-history \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "status": "IN_PROGRESS",
      "startAt": "2018-07-25T17:03:14.120Z",
      "updatedBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/goals/11e8902c9e2908c69718f13503066bee/status-history?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/goals/11e8902c9e2908c69718f13503066bee/status-history?offset=0&limit=20"
}

GET /goals/{goalId}/status-history

Retrieves a list of the statuses that have been applied to a goal. The list is primarily sorted by start date in reverse chronological order.

Parameters

Parameter In Type Required Default Description Accepted Values
goalId path string true N/A The ID of the goal. -
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK Retrieve the Status History for a Goal GoalStatusHistories
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Retrieve the Progress History for a Goal

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/goals/11e8591a4d5e569c8f673f9b3f4603ec/progress-history', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/goals/11e8591a4d5e569c8f673f9b3f4603ec/progress-history \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "progress": "PROGRESSING",
      "startAt": "2018-07-25T17:03:14.120Z",
      "updatedBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/goals/11e8902c9e2908c69718f13503066bee/progress-history?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/goals/11e8902c9e2908c69718f13503066bee/progress-history?offset=0&limit=20"
}

GET /goals/{goalId}/progress-history

Retrieves a list of the progresses that have been applied to a goal. A sequence of identical progresses indicates that progress toward the goal was reviewed and updated to the same value it had previously. The list is primarily sorted by start date in reverse chronological order.

Parameters

Parameter In Type Required Default Description Accepted Values
goalId path string true N/A The ID of the goal. -
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK Retrieve the Progress History for a Goal ProgressHistories
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Activity Definitions

Activity definitions act as templates that can be referenced when creating an activity. The set of activity definitions form a catalog of content that can be searched, selected, and customized when first establishing an activity for an individual.

Create an Activity Definition

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/activity-definitions', headers: headers, body: {"text":"Receive a flu shot","description":"A yearly flu vaccination is the best tool currently available to protect against influenza (flu), a serious disease that sickens millions of people each year. Flu vaccination can keep you from getting sick.","instantiatesUrl":"https://www.cdc.gov/flu/prevent/vaccine-benefits.htm","categories":[{"id":"11e818be2efb3d8f9c76653d4cc4a3f3"},{"id":"11e831f1150a0ec3a8a26933567de562"}],"disciplines":[{"id":"11c3a811c3900dc297c384c393c2bac2"},{"id":"11e8642c933ae8f48d534375f1bbef93"}],"supportingExternalReferences":[{"system":"https://dev.healthwise.net/services/services.content/v1/articles/","id":"4715932429582336"},{"system":"https://app.pluralsight.com/library/","id":"aws-developer-serverless-architecture-monitoring"}],"supportingReferences":[{"kind":"wellnessLearningModules#modules","id":"ecb8026a-64f9-11e8-adc0-fa7ae01bbebc"},{"kind":"education#content","id":"227ee4f0-6508-11e8-adc0-fa7ae01bbebc"}],"coding":[{"code":"11c3a811c3900dc297c384c393c2gac2","display":"Nutritional","system":"SNOMED CT"}],"status":"ACTIVE","targets":[{"measureTypeDescription":"HbA1c","measureType":{"contextId":"d1ef6dd8-a18c-429e-9a95-c77a5439956d","conceptAlias":"HEMOGLOBIN_A1C_PCT_BLOOD_OBSTYPE"},"detail":{"type":"NUMERIC","numeric":{"value":5.6,"operator":"<","unitDescription":"%","unit":{"contextId":"30517bf1-0c68-4d73-9557-456902a50563","conceptAlias":"PERCENT_UOM"}}}}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/activity-definitions \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"text":"Receive a flu shot","description":"A yearly flu vaccination is the best tool currently available to protect against influenza (flu), a serious disease that sickens millions of people each year. Flu vaccination can keep you from getting sick.","instantiatesUrl":"https://www.cdc.gov/flu/prevent/vaccine-benefits.htm","categories":[{"id":"11e818be2efb3d8f9c76653d4cc4a3f3"},{"id":"11e831f1150a0ec3a8a26933567de562"}],"disciplines":[{"id":"11c3a811c3900dc297c384c393c2bac2"},{"id":"11e8642c933ae8f48d534375f1bbef93"}],"supportingExternalReferences":[{"system":"https://dev.healthwise.net/services/services.content/v1/articles/","id":"4715932429582336"},{"system":"https://app.pluralsight.com/library/","id":"aws-developer-serverless-architecture-monitoring"}],"supportingReferences":[{"kind":"wellnessLearningModules#modules","id":"ecb8026a-64f9-11e8-adc0-fa7ae01bbebc"},{"kind":"education#content","id":"227ee4f0-6508-11e8-adc0-fa7ae01bbebc"}],"coding":[{"code":"11c3a811c3900dc297c384c393c2gac2","display":"Nutritional","system":"SNOMED CT"}],"status":"ACTIVE","targets":[{"measureTypeDescription":"HbA1c","measureType":{"contextId":"d1ef6dd8-a18c-429e-9a95-c77a5439956d","conceptAlias":"HEMOGLOBIN_A1C_PCT_BLOOD_OBSTYPE"},"detail":{"type":"NUMERIC","numeric":{"value":5.6,"operator":"<","unitDescription":"%","unit":{"contextId":"30517bf1-0c68-4d73-9557-456902a50563","conceptAlias":"PERCENT_UOM"}}}}]}

Example response

{
  "id": "11e8902c9e2908c69718f13503066bee",
  "text": "Receive a flu shot",
  "status": "ACTIVE",
  "categories": [
    {
      "id": "11e8902c9e2908c69718f13503066bee",
      "text": "Nutritional",
      "status": "ACTIVE",
      "coding": [
        {
          "code": "11c3a7c39225c391387341c2aac323fds",
          "system": "SNOMED CT",
          "display": "Nutritional"
        }
      ]
    }
  ],
  "disciplines": [
    {
      "id": "11e8902c9e2908c69718f13503066bef",
      "text": "Anesthesiology",
      "status": "ACTIVE",
      "coding": [
        {
          "code": "11c3a7c39225c391387341c2aac323fds",
          "system": "SNOMED CT",
          "display": "Anesthesiology"
        }
      ]
    }
  ],
  "coding": [
    {
      "code": "11c3a7c39225c391387341c2aac323fds",
      "system": "SNOMED CT",
      "display": "Nutritional"
    }
  ],
  "description": "A yearly flu vaccination is the best tool currently available to protect against influenza (flu), a serious disease that sickens millions of people each year. Flu vaccination can keep you from getting sick.",
  "instantiatesUrl": "https://www.cdc.gov/flu/prevent/vaccine-benefits.htm",
  "targets": [
    {
      "measureTypeDescription": "HbA1c",
      "measureType": {
        "contextId": "d1ef6dd8-a18c-429e-9a95-c77a5439956d",
        "conceptAlias": "HEMOGLOBIN_A1C_PCT_BLOOD_OBSTYPE"
      },
      "detail": {
        "type": "NUMERIC",
        "numeric": {
          "value": 5.6,
          "operator": "<",
          "unitDescription": "%",
          "unit": {
            "contextId": "30517bf1-0c68-4d73-9557-456902a50563",
            "conceptAlias": "PERCENT_UOM"
          }
        }
      }
    }
  ],
  "supportingExternalReferences": [
    {
      "system": "https://dev.healthwise.net/services/services.content/v1/articles/",
      "id": "4715932429582336"
    },
    {
      "system": "https://app.pluralsight.com/library/",
      "id": "aws-developer-serverless-architecture-monitoring"
    }
  ],
  "supportingReferences": [
    {
      "kind": "wellnessLearningModules#modules",
      "id": "ecb8026a-64f9-11e8-adc0-fa7ae01bbebc"
    },
    {
      "kind": "education#content",
      "id": "227ee4f0-6508-11e8-adc0-fa7ae01bbebc"
    }
  ]
}

POST /activity-definitions

Creates an activity definition.

Parameters

Parameter In Type Required Default Description Accepted Values
body body postActivityDefinitions true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created Create an Activity Definition ActivityDefinition
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Response Headers

Status Header Type Format Description
201 ETag string The ETag of a specific version of the activity definition.

Retrieve a List of Activity Definitions

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/activity-definitions', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/activity-definitions \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "11e8902c9e2908c69718f13503066bee",
      "text": "Receive a flu shot",
      "status": "ACTIVE",
      "categories": [
        {
          "id": "11e8902c9e2908c69718f13503066bee",
          "text": "Nutritional",
          "status": "ACTIVE",
          "coding": [
            {
              "code": "11c3a7c39225c391387341c2aac323fds",
              "system": "SNOMED CT",
              "display": "Nutritional"
            }
          ]
        }
      ],
      "disciplines": [
        {
          "id": "11e8902c9e2908c69718f13503066bef",
          "text": "Anesthesiology",
          "status": "ACTIVE",
          "coding": [
            {
              "code": "11c3a7c39225c391387341c2aac323fds",
              "system": "SNOMED CT",
              "display": "Anesthesiology"
            }
          ]
        }
      ],
      "coding": [
        {
          "code": "11c3a7c39225c391387341c2aac323fds",
          "system": "SNOMED CT",
          "display": "Nutritional"
        }
      ],
      "description": "A yearly flu vaccination is the best tool currently available to protect against influenza (flu), a serious disease that sickens millions of people each year. Flu vaccination can keep you from getting sick.",
      "instantiatesUrl": "https://www.cdc.gov/flu/prevent/vaccine-benefits.htm",
      "targets": [
        {
          "measureTypeDescription": "HbA1c",
          "measureType": {
            "contextId": "d1ef6dd8-a18c-429e-9a95-c77a5439956d",
            "conceptAlias": "HEMOGLOBIN_A1C_PCT_BLOOD_OBSTYPE"
          },
          "detail": {
            "type": "NUMERIC",
            "numeric": {
              "value": 5.6,
              "operator": "<",
              "unitDescription": "%",
              "unit": {
                "contextId": "30517bf1-0c68-4d73-9557-456902a50563",
                "conceptAlias": "PERCENT_UOM"
              }
            }
          }
        }
      ],
      "supportingExternalReferences": [
        {
          "system": "https://dev.healthwise.net/services/services.content/v1/articles/",
          "id": "4715932429582336"
        },
        {
          "system": "https://app.pluralsight.com/library/",
          "id": "aws-developer-serverless-architecture-monitoring"
        }
      ],
      "supportingReferences": [
        {
          "kind": "wellnessLearningModules#modules",
          "id": "ecb8026a-64f9-11e8-adc0-fa7ae01bbebc"
        },
        {
          "kind": "education#content",
          "id": "227ee4f0-6508-11e8-adc0-fa7ae01bbebc"
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/activity-definitions?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/activity-definitions?offset=0&limit=20"
}

GET /activity-definitions

Retrieves a list of activity definitions.

Parameters

Parameter In Type Required Default Description Accepted Values
code query array[string] false N/A Filters the retrieved activity definitions by code combinations. A code is the combination of a coding system and code divided by a vertical bar. For example, SNOMED CT code 11381005 for acne would be represented as ‘2.16.840.1.113883.6.96 | 11381005’. -
text query string false N/A Filters the retrieved activity definitions by the specified text. Partial matching is allowed. -
status query string false N/A Filters the retrieved activity definitions by status. ACTIVE, INACTIVE
categories query array[string] false N/A Filters the retrieved activity definitions to those with one of the specified category IDs. -
disciplines query array[string] false N/A Filters the retrieved activity definitions to those with one of the specified discipline IDs. -
supportingExternalReferenceSystem query string false N/A Filters the list of results to only those with external supporting references in the specified external system. The value for this parameter must be encoded if the system includes special characters, for example, https%3A%2F%2Fapp.pluralsight.com%2Flibrary for https://app.pluralsight.com/library. If supportingExternalReferenceSystem is specified, supportingExternalReferenceId must also be specified. -
supportingExternalReferenceId query string false N/A Filters the list of results to only those with the specified external supporting reference. If supportingExternalReferenceId is specified, supportingExternalReferenceSystem must also be specified. -
supportingReferenceKind query string false N/A Filters the list of results to only those with the specified kind of supporting reference. The value for this parameter must be encoded if the kind includes special characters, for example, welnessLearningModules%23modules for wellnessLearningModules#modules. If supportingReferenceKind is specified, supportingReferenceId must also be specified. -
supportingReferenceId query string false N/A Filters the list of results to only those with the specified supporting reference. If supportingReferenceId is specified, supportingReferenceKind must also be specified. -
id query array[string] false N/A Filters the list of results to only those with the specified activity definition ID. A single request can be sent for between 1 and 100 IDs. -
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK Retrieve a List of Activity Definitions ActivityDefinitions
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Update an Activity Definition

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'If-Match' => {
  "type": "string"
}
} 

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/activity-definitions/11e8591a4d5e569c8f673f9b3f4603ec', headers: headers, body: {"text":"Receive a flu shot","description":"A yearly flu vaccination is the best tool currently available to protect against influenza (flu), a serious disease that sickens millions of people each year. Flu vaccination can keep you from getting sick.","instantiatesUrl":"https://www.cdc.gov/flu/prevent/vaccine-benefits.htm","categories":[{"id":"11e818be2efb3d8f9c76653d4cc4a3f3"},{"id":"11e831f1150a0ec3a8a26933567de562"}],"disciplines":[{"id":"11c3a811c3900dc297c384c393c2bac2"},{"id":"11e8642c933ae8f48d534375f1bbef93"}],"supportingExternalReferences":[{"system":"https://dev.healthwise.net/services/services.content/v1/articles/","id":"4715932429582336"},{"system":"https://app.pluralsight.com/library/","id":"aws-developer-serverless-architecture-monitoring"}],"supportingReferences":[{"kind":"wellnessLearningModules#modules","id":"ecb8026a-64f9-11e8-adc0-fa7ae01bbebc"},{"kind":"education#content","id":"227ee4f0-6508-11e8-adc0-fa7ae01bbebc"}],"coding":[{"code":"11c3a811c3900dc297c384c393c2gac2","display":"Nutritional","system":"SNOMED CT"}],"status":"ACTIVE","targets":[{"measureTypeDescription":"HbA1c","measureType":{"contextId":"d1ef6dd8-a18c-429e-9a95-c77a5439956d","conceptAlias":"HEMOGLOBIN_A1C_PCT_BLOOD_OBSTYPE"},"detail":{"type":"NUMERIC","numeric":{"value":5.6,"operator":"<","unitDescription":"%","unit":{"contextId":"30517bf1-0c68-4d73-9557-456902a50563","conceptAlias":"PERCENT_UOM"}}}}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/activity-definitions/11e8591a4d5e569c8f673f9b3f4603ec \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \ \
-H 'If-Match: [object Object]' \
-d {"text":"Receive a flu shot","description":"A yearly flu vaccination is the best tool currently available to protect against influenza (flu), a serious disease that sickens millions of people each year. Flu vaccination can keep you from getting sick.","instantiatesUrl":"https://www.cdc.gov/flu/prevent/vaccine-benefits.htm","categories":[{"id":"11e818be2efb3d8f9c76653d4cc4a3f3"},{"id":"11e831f1150a0ec3a8a26933567de562"}],"disciplines":[{"id":"11c3a811c3900dc297c384c393c2bac2"},{"id":"11e8642c933ae8f48d534375f1bbef93"}],"supportingExternalReferences":[{"system":"https://dev.healthwise.net/services/services.content/v1/articles/","id":"4715932429582336"},{"system":"https://app.pluralsight.com/library/","id":"aws-developer-serverless-architecture-monitoring"}],"supportingReferences":[{"kind":"wellnessLearningModules#modules","id":"ecb8026a-64f9-11e8-adc0-fa7ae01bbebc"},{"kind":"education#content","id":"227ee4f0-6508-11e8-adc0-fa7ae01bbebc"}],"coding":[{"code":"11c3a811c3900dc297c384c393c2gac2","display":"Nutritional","system":"SNOMED CT"}],"status":"ACTIVE","targets":[{"measureTypeDescription":"HbA1c","measureType":{"contextId":"d1ef6dd8-a18c-429e-9a95-c77a5439956d","conceptAlias":"HEMOGLOBIN_A1C_PCT_BLOOD_OBSTYPE"},"detail":{"type":"NUMERIC","numeric":{"value":5.6,"operator":"<","unitDescription":"%","unit":{"contextId":"30517bf1-0c68-4d73-9557-456902a50563","conceptAlias":"PERCENT_UOM"}}}}]}

Example response

{
  "id": "11e8902c9e2908c69718f13503066bee",
  "text": "Receive a flu shot",
  "status": "ACTIVE",
  "categories": [
    {
      "id": "11e8902c9e2908c69718f13503066bee",
      "text": "Nutritional",
      "status": "ACTIVE",
      "coding": [
        {
          "code": "11c3a7c39225c391387341c2aac323fds",
          "system": "SNOMED CT",
          "display": "Nutritional"
        }
      ]
    }
  ],
  "disciplines": [
    {
      "id": "11e8902c9e2908c69718f13503066bef",
      "text": "Anesthesiology",
      "status": "ACTIVE",
      "coding": [
        {
          "code": "11c3a7c39225c391387341c2aac323fds",
          "system": "SNOMED CT",
          "display": "Anesthesiology"
        }
      ]
    }
  ],
  "coding": [
    {
      "code": "11c3a7c39225c391387341c2aac323fds",
      "system": "SNOMED CT",
      "display": "Nutritional"
    }
  ],
  "description": "A yearly flu vaccination is the best tool currently available to protect against influenza (flu), a serious disease that sickens millions of people each year. Flu vaccination can keep you from getting sick.",
  "instantiatesUrl": "https://www.cdc.gov/flu/prevent/vaccine-benefits.htm",
  "targets": [
    {
      "measureTypeDescription": "HbA1c",
      "measureType": {
        "contextId": "d1ef6dd8-a18c-429e-9a95-c77a5439956d",
        "conceptAlias": "HEMOGLOBIN_A1C_PCT_BLOOD_OBSTYPE"
      },
      "detail": {
        "type": "NUMERIC",
        "numeric": {
          "value": 5.6,
          "operator": "<",
          "unitDescription": "%",
          "unit": {
            "contextId": "30517bf1-0c68-4d73-9557-456902a50563",
            "conceptAlias": "PERCENT_UOM"
          }
        }
      }
    }
  ],
  "supportingExternalReferences": [
    {
      "system": "https://dev.healthwise.net/services/services.content/v1/articles/",
      "id": "4715932429582336"
    },
    {
      "system": "https://app.pluralsight.com/library/",
      "id": "aws-developer-serverless-architecture-monitoring"
    }
  ],
  "supportingReferences": [
    {
      "kind": "wellnessLearningModules#modules",
      "id": "ecb8026a-64f9-11e8-adc0-fa7ae01bbebc"
    },
    {
      "kind": "education#content",
      "id": "227ee4f0-6508-11e8-adc0-fa7ae01bbebc"
    }
  ]
}

PUT /activity-definitions/{activityDefinitionId}

Updates a single activity definition.

Parameters

Parameter In Type Required Default Description Accepted Values
If-Match header string true N/A The specific version of the activity definition to update. -
activityDefinitionId path string true N/A The ID of the activity definition. -
body body putActivityDefinitions true N/A No description -

Response Statuses

Status Meaning Description Schema
200 OK Update an Activity Definition ActivityDefinition
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error
412 Precondition Failed Precondition Failed Error
428 Precondition Required Precondition Required Error

Response Headers

Status Header Type Format Description
200 ETag string The ETag of a specific version of the Activity definition.

Retrieve a Single Activity Definition

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/activity-definitions/11e8902c9e2908c69718f13503066bee', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/activity-definitions/11e8902c9e2908c69718f13503066bee \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "11e8902c9e2908c69718f13503066bee",
  "text": "Receive a flu shot",
  "status": "ACTIVE",
  "categories": [
    {
      "id": "11e8902c9e2908c69718f13503066bee",
      "text": "Nutritional",
      "status": "ACTIVE",
      "coding": [
        {
          "code": "11c3a7c39225c391387341c2aac323fds",
          "system": "SNOMED CT",
          "display": "Nutritional"
        }
      ]
    }
  ],
  "disciplines": [
    {
      "id": "11e8902c9e2908c69718f13503066bef",
      "text": "Anesthesiology",
      "status": "ACTIVE",
      "coding": [
        {
          "code": "11c3a7c39225c391387341c2aac323fds",
          "system": "SNOMED CT",
          "display": "Anesthesiology"
        }
      ]
    }
  ],
  "coding": [
    {
      "code": "11c3a7c39225c391387341c2aac323fds",
      "system": "SNOMED CT",
      "display": "Nutritional"
    }
  ],
  "description": "A yearly flu vaccination is the best tool currently available to protect against influenza (flu), a serious disease that sickens millions of people each year. Flu vaccination can keep you from getting sick.",
  "instantiatesUrl": "https://www.cdc.gov/flu/prevent/vaccine-benefits.htm",
  "targets": [
    {
      "measureTypeDescription": "HbA1c",
      "measureType": {
        "contextId": "d1ef6dd8-a18c-429e-9a95-c77a5439956d",
        "conceptAlias": "HEMOGLOBIN_A1C_PCT_BLOOD_OBSTYPE"
      },
      "detail": {
        "type": "NUMERIC",
        "numeric": {
          "value": 5.6,
          "operator": "<",
          "unitDescription": "%",
          "unit": {
            "contextId": "30517bf1-0c68-4d73-9557-456902a50563",
            "conceptAlias": "PERCENT_UOM"
          }
        }
      }
    }
  ],
  "supportingExternalReferences": [
    {
      "system": "https://dev.healthwise.net/services/services.content/v1/articles/",
      "id": "4715932429582336"
    },
    {
      "system": "https://app.pluralsight.com/library/",
      "id": "aws-developer-serverless-architecture-monitoring"
    }
  ],
  "supportingReferences": [
    {
      "kind": "wellnessLearningModules#modules",
      "id": "ecb8026a-64f9-11e8-adc0-fa7ae01bbebc"
    },
    {
      "kind": "education#content",
      "id": "227ee4f0-6508-11e8-adc0-fa7ae01bbebc"
    }
  ]
}

GET /activity-definitions/{activityDefinitionId}

Retrieves a single activity definition by ID.

Parameters

Parameter In Type Required Default Description Accepted Values
activityDefinitionId path string true N/A The ID of the activity definition. -

Response Statuses

Status Meaning Description Schema
200 OK Retrieve a Single Activity Definition ActivityDefinition
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Response Headers

Status Header Type Format Description
200 ETag string The ETag of a specific version of the activity definition.

Goal Definitions

Goal definitions act as templates that can be referenced when creating a goal. The set of goal definitions form a catalog of content that can be searched, selected, and customized when first establishing a goal for an individual.

Create a Goal Definition

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/goal-definitions', headers: headers, body: {"text":"Receive a flu shot","categories":[{"id":"11e818be2efb3d8f9c76653d4cc4a3f3"},{"id":"11e831f1150a0ec3a8a26933567de562"}],"disciplines":[{"id":"11c3a811c3900dc297c384c393c2bac2"},{"id":"11e8642c933ae8f48d534375f1bbef93"}],"coding":[{"code":"11c3a811c3900dc297c384c393c2gac2","display":"Nutritional","system":"SNOMED CT"}],"status":"ACTIVE","targets":[{"measureTypeDescription":"HbA1c","measureType":{"contextId":"d1ef6dd8-a18c-429e-9a95-c77a5439956d","conceptAlias":"HEMOGLOBIN_A1C_PCT_BLOOD_OBSTYPE"},"detail":{"type":"NUMERIC","numeric":{"value":5.6,"operator":"<","unitDescription":"%","unit":{"contextId":"30517bf1-0c68-4d73-9557-456902a50563","conceptAlias":"PERCENT_UOM"}}}}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/goal-definitions \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"text":"Receive a flu shot","categories":[{"id":"11e818be2efb3d8f9c76653d4cc4a3f3"},{"id":"11e831f1150a0ec3a8a26933567de562"}],"disciplines":[{"id":"11c3a811c3900dc297c384c393c2bac2"},{"id":"11e8642c933ae8f48d534375f1bbef93"}],"coding":[{"code":"11c3a811c3900dc297c384c393c2gac2","display":"Nutritional","system":"SNOMED CT"}],"status":"ACTIVE","targets":[{"measureTypeDescription":"HbA1c","measureType":{"contextId":"d1ef6dd8-a18c-429e-9a95-c77a5439956d","conceptAlias":"HEMOGLOBIN_A1C_PCT_BLOOD_OBSTYPE"},"detail":{"type":"NUMERIC","numeric":{"value":5.6,"operator":"<","unitDescription":"%","unit":{"contextId":"30517bf1-0c68-4d73-9557-456902a50563","conceptAlias":"PERCENT_UOM"}}}}]}

Example response

{
  "id": "11e8902c9e2908c69718f13503066bee",
  "text": "Receive a flu shot",
  "status": "ACTIVE",
  "categories": [
    {
      "id": "11e8902c9e2908c69718f13503066bee",
      "text": "Nutritional",
      "status": "ACTIVE",
      "coding": [
        {
          "code": "11c3a7c39225c391387341c2aac323fds",
          "system": "SNOMED CT",
          "display": "Nutritional"
        }
      ]
    }
  ],
  "disciplines": [
    {
      "id": "11e8902c9e2908c69718f13503066bef",
      "text": "Anesthesiology",
      "status": "ACTIVE",
      "coding": [
        {
          "code": "11c3a7c39225c391387341c2aac323fds",
          "system": "SNOMED CT",
          "display": "Anesthesiology"
        }
      ]
    }
  ],
  "coding": [
    {
      "code": "11c3a7c39225c391387341c2aac323fds",
      "system": "SNOMED CT",
      "display": "Nutritional"
    }
  ],
  "targets": [
    {
      "measureTypeDescription": "HbA1c",
      "measureType": {
        "contextId": "d1ef6dd8-a18c-429e-9a95-c77a5439956d",
        "conceptAlias": "HEMOGLOBIN_A1C_PCT_BLOOD_OBSTYPE"
      },
      "detail": {
        "type": "NUMERIC",
        "numeric": {
          "value": 5.6,
          "operator": "<",
          "unitDescription": "%",
          "unit": {
            "contextId": "30517bf1-0c68-4d73-9557-456902a50563",
            "conceptAlias": "PERCENT_UOM"
          }
        }
      }
    }
  ]
}

POST /goal-definitions

Creates a goal definition.

Parameters

Parameter In Type Required Default Description Accepted Values
body body postGoalDefinitions true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created Create a Goal Definition GoalDefinition
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Response Headers

Status Header Type Format Description
201 ETag string The ETag of a specific version of the goal definition.

Retrieve a List of Goal Definitions

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/goal-definitions', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/goal-definitions \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "11e8902c9e2908c69718f13503066bee",
      "text": "Receive a flu shot",
      "status": "ACTIVE",
      "categories": [
        {
          "id": "11e8902c9e2908c69718f13503066bee",
          "text": "Nutritional",
          "status": "ACTIVE",
          "coding": [
            {
              "code": "11c3a7c39225c391387341c2aac323fds",
              "system": "SNOMED CT",
              "display": "Nutritional"
            }
          ]
        }
      ],
      "disciplines": [
        {
          "id": "11e8902c9e2908c69718f13503066bef",
          "text": "Anesthesiology",
          "status": "ACTIVE",
          "coding": [
            {
              "code": "11c3a7c39225c391387341c2aac323fds",
              "system": "SNOMED CT",
              "display": "Anesthesiology"
            }
          ]
        }
      ],
      "coding": [
        {
          "code": "11c3a7c39225c391387341c2aac323fds",
          "system": "SNOMED CT",
          "display": "Nutritional"
        }
      ],
      "targets": [
        {
          "measureTypeDescription": "HbA1c",
          "measureType": {
            "contextId": "d1ef6dd8-a18c-429e-9a95-c77a5439956d",
            "conceptAlias": "HEMOGLOBIN_A1C_PCT_BLOOD_OBSTYPE"
          },
          "detail": {
            "type": "NUMERIC",
            "numeric": {
              "value": 5.6,
              "operator": "<",
              "unitDescription": "%",
              "unit": {
                "contextId": "30517bf1-0c68-4d73-9557-456902a50563",
                "conceptAlias": "PERCENT_UOM"
              }
            }
          }
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/goal-definitions?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/goal-definitions?offset=0&limit=20"
}

GET /goal-definitions

Retrieves a list of goal definitions.

Parameters

Parameter In Type Required Default Description Accepted Values
code query array[string] false N/A Filters the retrieved goal definitions by code combinations. A code is the combination of a coding system and code divided by a vertical bar. For example, SNOMED CT code 11381005 for acne would be represented as ‘2.16.840.1.113883.6.96 | 11381005’. -
text query string false N/A Filters the retrieved goal definitions by the specified text. Partial matching is allowed. -
status query string false N/A Filters the retrieved goal definitions by status. ACTIVE, INACTIVE
categories query array[string] false N/A Filters the retrieved goal definitions to those with one of the specified category IDs. -
disciplines query array[string] false N/A Filters the retrieved goal definitions to those with one of the specified discipline IDs. -
id query array[string] false N/A Filters the list of results to only those with the specified goal definition ID. A single request can be sent for between 1 and 100 IDs. -
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK Retrieve a List of Goal Definitions GoalDefinitions
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Update a Goal Definition

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'If-Match' => {
  "type": "string"
}
} 

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/goal-definitions/11e8591a4d5e569c8f673f9b3f4603ec', headers: headers, body: {"text":"Receive a flu shot","categories":[{"id":"11e818be2efb3d8f9c76653d4cc4a3f3"},{"id":"11e831f1150a0ec3a8a26933567de562"}],"disciplines":[{"id":"11c3a811c3900dc297c384c393c2bac2"},{"id":"11e8642c933ae8f48d534375f1bbef93"}],"coding":[{"code":"11c3a811c3900dc297c384c393c2gac2","display":"Nutritional","system":"SNOMED CT"}],"status":"ACTIVE","targets":[{"measureTypeDescription":"HbA1c","measureType":{"contextId":"d1ef6dd8-a18c-429e-9a95-c77a5439956d","conceptAlias":"HEMOGLOBIN_A1C_PCT_BLOOD_OBSTYPE"},"detail":{"type":"NUMERIC","numeric":{"value":5.6,"operator":"<","unitDescription":"%","unit":{"contextId":"30517bf1-0c68-4d73-9557-456902a50563","conceptAlias":"PERCENT_UOM"}}}}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/goal-definitions/11e8591a4d5e569c8f673f9b3f4603ec \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \ \
-H 'If-Match: [object Object]' \
-d {"text":"Receive a flu shot","categories":[{"id":"11e818be2efb3d8f9c76653d4cc4a3f3"},{"id":"11e831f1150a0ec3a8a26933567de562"}],"disciplines":[{"id":"11c3a811c3900dc297c384c393c2bac2"},{"id":"11e8642c933ae8f48d534375f1bbef93"}],"coding":[{"code":"11c3a811c3900dc297c384c393c2gac2","display":"Nutritional","system":"SNOMED CT"}],"status":"ACTIVE","targets":[{"measureTypeDescription":"HbA1c","measureType":{"contextId":"d1ef6dd8-a18c-429e-9a95-c77a5439956d","conceptAlias":"HEMOGLOBIN_A1C_PCT_BLOOD_OBSTYPE"},"detail":{"type":"NUMERIC","numeric":{"value":5.6,"operator":"<","unitDescription":"%","unit":{"contextId":"30517bf1-0c68-4d73-9557-456902a50563","conceptAlias":"PERCENT_UOM"}}}}]}

Example response

{
  "id": "11e8902c9e2908c69718f13503066bee",
  "text": "Receive a flu shot",
  "status": "ACTIVE",
  "categories": [
    {
      "id": "11e8902c9e2908c69718f13503066bee",
      "text": "Nutritional",
      "status": "ACTIVE",
      "coding": [
        {
          "code": "11c3a7c39225c391387341c2aac323fds",
          "system": "SNOMED CT",
          "display": "Nutritional"
        }
      ]
    }
  ],
  "disciplines": [
    {
      "id": "11e8902c9e2908c69718f13503066bef",
      "text": "Anesthesiology",
      "status": "ACTIVE",
      "coding": [
        {
          "code": "11c3a7c39225c391387341c2aac323fds",
          "system": "SNOMED CT",
          "display": "Anesthesiology"
        }
      ]
    }
  ],
  "coding": [
    {
      "code": "11c3a7c39225c391387341c2aac323fds",
      "system": "SNOMED CT",
      "display": "Nutritional"
    }
  ],
  "targets": [
    {
      "measureTypeDescription": "HbA1c",
      "measureType": {
        "contextId": "d1ef6dd8-a18c-429e-9a95-c77a5439956d",
        "conceptAlias": "HEMOGLOBIN_A1C_PCT_BLOOD_OBSTYPE"
      },
      "detail": {
        "type": "NUMERIC",
        "numeric": {
          "value": 5.6,
          "operator": "<",
          "unitDescription": "%",
          "unit": {
            "contextId": "30517bf1-0c68-4d73-9557-456902a50563",
            "conceptAlias": "PERCENT_UOM"
          }
        }
      }
    }
  ]
}

PUT /goal-definitions/{goalDefinitionId}

Updates a single goal definition.

Parameters

Parameter In Type Required Default Description Accepted Values
If-Match header string true N/A The specific version of the goal definition to update. -
goalDefinitionId path string true N/A The ID of the goal definition. -
body body putGoalDefinitions true N/A No description -

Response Statuses

Status Meaning Description Schema
200 OK Update a Goal Definition GoalDefinition
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error
412 Precondition Failed Precondition Failed Error
428 Precondition Required Precondition Required Error

Response Headers

Status Header Type Format Description
200 ETag string The ETag of a specific version of the goal definition.

Retrieve a Single Goal Definition

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/goal-definitions/11e8902c9e2908c69718f13503066bee', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/goal-definitions/11e8902c9e2908c69718f13503066bee \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "11e8902c9e2908c69718f13503066bee",
  "text": "Receive a flu shot",
  "status": "ACTIVE",
  "categories": [
    {
      "id": "11e8902c9e2908c69718f13503066bee",
      "text": "Nutritional",
      "status": "ACTIVE",
      "coding": [
        {
          "code": "11c3a7c39225c391387341c2aac323fds",
          "system": "SNOMED CT",
          "display": "Nutritional"
        }
      ]
    }
  ],
  "disciplines": [
    {
      "id": "11e8902c9e2908c69718f13503066bef",
      "text": "Anesthesiology",
      "status": "ACTIVE",
      "coding": [
        {
          "code": "11c3a7c39225c391387341c2aac323fds",
          "system": "SNOMED CT",
          "display": "Anesthesiology"
        }
      ]
    }
  ],
  "coding": [
    {
      "code": "11c3a7c39225c391387341c2aac323fds",
      "system": "SNOMED CT",
      "display": "Nutritional"
    }
  ],
  "targets": [
    {
      "measureTypeDescription": "HbA1c",
      "measureType": {
        "contextId": "d1ef6dd8-a18c-429e-9a95-c77a5439956d",
        "conceptAlias": "HEMOGLOBIN_A1C_PCT_BLOOD_OBSTYPE"
      },
      "detail": {
        "type": "NUMERIC",
        "numeric": {
          "value": 5.6,
          "operator": "<",
          "unitDescription": "%",
          "unit": {
            "contextId": "30517bf1-0c68-4d73-9557-456902a50563",
            "conceptAlias": "PERCENT_UOM"
          }
        }
      }
    }
  ]
}

GET /goal-definitions/{goalDefinitionId}

Retrieves a single goal definition by ID.

Parameters

Parameter In Type Required Default Description Accepted Values
goalDefinitionId path string true N/A The ID of the goal definition. -

Response Statuses

Status Meaning Description Schema
200 OK Retrieve a Single Goal Definition GoalDefinition
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Response Headers

Status Header Type Format Description
200 ETag string The ETag of a specific version of the goal definition.

Categories

Categories are assigned to goals and activities when they are created. Categories can also be assigned to goal and activity definitions to categorize the content.

Create a Category

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/categories', headers: headers, body: {"text":"Nutritional","status":"ACTIVE","coding":[{"code":"11c3a7c39225c391387341c2aac323fds","system":"SNOMED CT","display":"Nutritional"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/categories \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"text":"Nutritional","status":"ACTIVE","coding":[{"code":"11c3a7c39225c391387341c2aac323fds","system":"SNOMED CT","display":"Nutritional"}]}

Example response

{
  "id": "11e8902c9e2908c69718f13503066bee",
  "text": "Nutritional",
  "status": "ACTIVE",
  "coding": [
    {
      "code": "11c3a7c39225c391387341c2aac323fds",
      "system": "SNOMED CT",
      "display": "Nutritional"
    }
  ],
  "version": 1
}

POST /categories

Creates a category.

Parameters

Parameter In Type Required Default Description Accepted Values
body body postCategories true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created Create a Category Category
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Retrieve a List of Categories

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/categories', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/categories \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "11e8902c9e2908c69718f13503066bee",
      "text": "Nutritional",
      "status": "ACTIVE",
      "coding": [
        {
          "code": "11c3a7c39225c391387341c2aac323fds",
          "system": "SNOMED CT",
          "display": "Nutritional"
        }
      ],
      "version": 1
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/categories?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/categories?offset=0&limit=20"
}

GET /categories

Retrieves a list of categories.

Parameters

Parameter In Type Required Default Description Accepted Values
text query string false N/A Filters the retrieved categories to those that contain the specified text. Partial matching is allowed. -
status query string false N/A Filters the retrieved categories by status. ACTIVE, INACTIVE
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK Retrieve a List of Categories Categories
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Update a Category

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'If-Match' => {
  "type": "string"
}
} 

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/categories/{categoryId}', headers: headers, body: {"text":"Nutritional","status":"ACTIVE","coding":[{"code":"11c3a7c39225c391387341c2aac323fds","system":"SNOMED CT","display":"Nutritional"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/categories/{categoryId} \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \ \
-H 'If-Match: [object Object]' \
-d {"text":"Nutritional","status":"ACTIVE","coding":[{"code":"11c3a7c39225c391387341c2aac323fds","system":"SNOMED CT","display":"Nutritional"}]}

Example response

{
  "id": "11e8902c9e2908c69718f13503066bee",
  "text": "Nutritional",
  "status": "ACTIVE",
  "coding": [
    {
      "code": "11c3a7c39225c391387341c2aac323fds",
      "system": "SNOMED CT",
      "display": "Nutritional"
    }
  ],
  "version": 1
}

PUT /categories/{categoryId}

Updates a category.

Parameters

Parameter In Type Required Default Description Accepted Values
If-Match header string true N/A The specific version of the category resource to update. -
categoryId path string true N/A The ID of the category. -
body body putCategories true N/A No description -

Response Statuses

Status Meaning Description Schema
200 OK Update a Category Category
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error
412 Precondition Failed Precondition Failed Error
428 Precondition Required Precondition Required Error

Retrieve a Single Category

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/categories/{categoryId}', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/categories/{categoryId} \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "11e8902c9e2908c69718f13503066bee",
  "text": "Nutritional",
  "status": "ACTIVE",
  "coding": [
    {
      "code": "11c3a7c39225c391387341c2aac323fds",
      "system": "SNOMED CT",
      "display": "Nutritional"
    }
  ],
  "version": 1
}

GET /categories/{categoryId}

Retrieves a single category.

Parameters

Parameter In Type Required Default Description Accepted Values
categoryId path string true N/A The ID of the category. -

Response Statuses

Status Meaning Description Schema
200 OK Retrieve a Single Category Category
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Disciplines

Disciplines are assigned to goals and activities when they are created. Disciplines can also be assigned to goal and activity definitions to categorize the content.

Create a Discipline

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/disciplines', headers: headers, body: {"text":"Nutritional","status":"ACTIVE","coding":[{"code":"11c3a7c39225c391387341c2aac323fds","system":"SNOMED CT","display":"Nutritional"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/disciplines \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"text":"Nutritional","status":"ACTIVE","coding":[{"code":"11c3a7c39225c391387341c2aac323fds","system":"SNOMED CT","display":"Nutritional"}]}

Example response

{
  "id": "11e8902c9e2908c69718f13503066bee",
  "text": "Occupational Therapy",
  "status": "ACTIVE",
  "coding": [
    {
      "code": "11c3a7c39225c391387341c2aac323fds",
      "system": "SNOMED CT",
      "display": "Nutritional"
    }
  ],
  "version": 1
}

POST /disciplines

Creates a discipline.

Parameters

Parameter In Type Required Default Description Accepted Values
body body postDisciplines true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created Create a Discipline Discipline
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Retrieve a List of Disciplines

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/disciplines', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/disciplines \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "11e8902c9e2908c69718f13503066bee",
      "text": "Occupational Therapy",
      "status": "ACTIVE",
      "coding": [
        {
          "code": "11c3a7c39225c391387341c2aac323fds",
          "system": "SNOMED CT",
          "display": "Nutritional"
        }
      ],
      "version": 1
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/disciplines?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/disciplines?offset=0&limit=20"
}

GET /disciplines

Retrieves a list of disciplines.

Parameters

Parameter In Type Required Default Description Accepted Values
text query string false N/A Filters the retrieved disciplines to those that contain the specified text. Partial matching is allowed. -
status query string false N/A Filters the retrieved disciplines by status. ACTIVE, INACTIVE
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK Retrieve a List of Disciplines Disciplines
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Update a Discipline

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'If-Match' => {
  "type": "string"
}
} 

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/disciplines/{disciplineId}', headers: headers, body: {"text":"Nutritional","status":"ACTIVE","coding":[{"code":"11c3a7c39225c391387341c2aac323fds","system":"SNOMED CT","display":"Nutritional"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/disciplines/{disciplineId} \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \ \
-H 'If-Match: [object Object]' \
-d {"text":"Nutritional","status":"ACTIVE","coding":[{"code":"11c3a7c39225c391387341c2aac323fds","system":"SNOMED CT","display":"Nutritional"}]}

Example response

{
  "id": "11e8902c9e2908c69718f13503066bee",
  "text": "Occupational Therapy",
  "status": "ACTIVE",
  "coding": [
    {
      "code": "11c3a7c39225c391387341c2aac323fds",
      "system": "SNOMED CT",
      "display": "Nutritional"
    }
  ],
  "version": 1
}

PUT /disciplines/{disciplineId}

Updates a discipline.

Parameters

Parameter In Type Required Default Description Accepted Values
If-Match header string true N/A The specific version of the discipline resource to update. -
disciplineId path string true N/A The ID of the discipline. -
body body putDisciplines true N/A No description -

Response Statuses

Status Meaning Description Schema
200 OK Update a Discipline Discipline
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error
412 Precondition Failed Precondition Failed Error
428 Precondition Required Precondition Required Error

Retrieve a Single Discipline

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/disciplines/{disciplineId}', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/disciplines/{disciplineId} \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "11e8902c9e2908c69718f13503066bee",
  "text": "Occupational Therapy",
  "status": "ACTIVE",
  "coding": [
    {
      "code": "11c3a7c39225c391387341c2aac323fds",
      "system": "SNOMED CT",
      "display": "Nutritional"
    }
  ],
  "version": 1
}

GET /disciplines/{disciplineId}

Retrieves a single discipline.

Parameters

Parameter In Type Required Default Description Accepted Values
disciplineId path string true N/A The ID of the discipline. -

Response Statuses

Status Meaning Description Schema
200 OK Retrieve a Single Discipline Discipline
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Strengths

Strengths are an individual’s assets, areas of life where they are doing well or have an interest or ability. See the following examples:

To align goals with an individual’s strengths, users need to be able to document the strengths of a person and describe how the care plan is centered on those strengths.

Retrieve a List of Strengths

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/strengths', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/strengths \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "186ca582adf248aa8850edfb7dec38df",
      "consumer": {
        "id": "d8454f2a-665c-49d4-87db-8c167feae10e"
      },
      "description": "Walks several miles each day.",
      "startDate": "2018-07-04",
      "endDate": "2018-07-04",
      "status": "DOCUMENTED",
      "performedBy": {
        "display": "A A McCain",
        "type": "RELATED_PERSON"
      },
      "strengthDefinition": {
        "id": "186ca582adf248aa8850edfb7dec38df",
        "text": "Physically Active"
      },
      "originatingSourceEncounter": {
        "id": "09920f12-006f-44za-019d-12kdk23094ee1",
        "dataPartitionId": "4de3a1ab-5783-4e30-ba60-551ab1cf86fc"
      },
      "updatedSourceEncounter": {
        "id": "09920f12-006f-44za-019d-12kdk23094ee2",
        "dataPartitionId": "4de3a1ab-5783-4e30-ba60-551ab1cf86fc"
      },
      "version": 1,
      "createdBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "createdAt": "2018-02-13T20:41:18.181Z",
      "updatedBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "updatedAt": "2018-02-13T20:41:18.181Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/strengths?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/strengths?offset=0&limit=20"
}

GET /consumers/{consumerId}/strengths

Retrieves a list of strengths for a consumer.

Parameters

Parameter In Type Required Default Description Accepted Values
consumerId path string true N/A The ID of a HealtheIntent consumer. See Consumer API for more information. -
status query array[string] false N/A Filters by the current status of the strength. DOCUMENTED, IN_ERROR
effectiveDate query string false N/A Filters the response to only strengths with a start date that occurs on or before the specified effective date and an end date that occurs on or after the specified date. If the strength has no end date, the strength is included on the retrieved list as long as the start date is on or before the effective date. In International Organization for Standardization (ISO) 8601 format (YYYY-MM-DD). -
id query array[string] false N/A Filters the list of results to only those with the specified strength ID. A single request can be sent for between 1 and 100 IDs. -
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK Retrieve a List of Strengths Strengths
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Create a Strength

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/strengths', headers: headers, body: {"endDate":"2018-07-04","description":"Walks several miles each day.","startDate":"2018-07-04","performedBy":{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}},"strengthDefinition":{"id":"11e8901b64b1ca0b9c300d1ad3125a48"},"createdBy":{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}},"originatingSourceEncounter":{"id":"11e8901b64b1ca0b9c300d1ad3125a48","dataPartitionId":"4de3a1ab-5783-4e30-ba60-551ab1cf86fc"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/strengths \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"endDate":"2018-07-04","description":"Walks several miles each day.","startDate":"2018-07-04","performedBy":{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}},"strengthDefinition":{"id":"11e8901b64b1ca0b9c300d1ad3125a48"},"createdBy":{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}},"originatingSourceEncounter":{"id":"11e8901b64b1ca0b9c300d1ad3125a48","dataPartitionId":"4de3a1ab-5783-4e30-ba60-551ab1cf86fc"}}

Example response

{
  "id": "186ca582adf248aa8850edfb7dec38df",
  "consumer": {
    "id": "d8454f2a-665c-49d4-87db-8c167feae10e"
  },
  "description": "Walks several miles each day.",
  "startDate": "2018-07-04",
  "endDate": "2018-07-04",
  "status": "DOCUMENTED",
  "performedBy": {
    "display": "A A McCain",
    "type": "RELATED_PERSON"
  },
  "strengthDefinition": {
    "id": "186ca582adf248aa8850edfb7dec38df",
    "text": "Physically Active"
  },
  "originatingSourceEncounter": {
    "id": "09920f12-006f-44za-019d-12kdk23094ee1",
    "dataPartitionId": "4de3a1ab-5783-4e30-ba60-551ab1cf86fc"
  },
  "updatedSourceEncounter": {
    "id": "09920f12-006f-44za-019d-12kdk23094ee2",
    "dataPartitionId": "4de3a1ab-5783-4e30-ba60-551ab1cf86fc"
  },
  "version": 1,
  "createdBy": {
    "type": "PERSONNEL",
    "reference": {
      "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
    }
  },
  "createdAt": "2018-02-13T20:41:18.181Z",
  "updatedBy": {
    "type": "PERSONNEL",
    "reference": {
      "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
    }
  },
  "updatedAt": "2018-02-13T20:41:18.181Z"
}

POST /consumers/{consumerId}/strengths

Creates a strength for a consumer.

Parameters

Parameter In Type Required Default Description Accepted Values
consumerId path string true N/A The ID of a HealtheIntent consumer. See Consumer API for more information. -
body body postConsumersConsumeridStrengths true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created Create a Strength Strength
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Response Headers

Status Header Type Format Description
201 ETag string The entity tag (ETag) of a specific version of the strength.

Update a Strength

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'If-Match' => {
  "type": "string"
}
} 

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/strengths/186ca582adf248aa8850edfb7dec38df', headers: headers, body: {"endDate":"2018-07-04","description":"Walks several miles each day.","startDate":"2018-07-04","performedBy":{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}},"status":"DOCUMENTED","updatedBy":{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}},"updatedSourceEncounter":{"id":"11e8901b64b1ca0b9c300d1ad3125a48","dataPartitionId":"4de3a1ab-5783-4e30-ba60-551ab1cf86fc"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/strengths/186ca582adf248aa8850edfb7dec38df \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \ \
-H 'If-Match: [object Object]' \
-d {"endDate":"2018-07-04","description":"Walks several miles each day.","startDate":"2018-07-04","performedBy":{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}},"status":"DOCUMENTED","updatedBy":{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}},"updatedSourceEncounter":{"id":"11e8901b64b1ca0b9c300d1ad3125a48","dataPartitionId":"4de3a1ab-5783-4e30-ba60-551ab1cf86fc"}}

Example response

{
  "id": "186ca582adf248aa8850edfb7dec38df",
  "consumer": {
    "id": "d8454f2a-665c-49d4-87db-8c167feae10e"
  },
  "description": "Walks several miles each day.",
  "startDate": "2018-07-04",
  "endDate": "2018-07-04",
  "status": "DOCUMENTED",
  "performedBy": {
    "display": "A A McCain",
    "type": "RELATED_PERSON"
  },
  "strengthDefinition": {
    "id": "186ca582adf248aa8850edfb7dec38df",
    "text": "Physically Active"
  },
  "originatingSourceEncounter": {
    "id": "09920f12-006f-44za-019d-12kdk23094ee1",
    "dataPartitionId": "4de3a1ab-5783-4e30-ba60-551ab1cf86fc"
  },
  "updatedSourceEncounter": {
    "id": "09920f12-006f-44za-019d-12kdk23094ee2",
    "dataPartitionId": "4de3a1ab-5783-4e30-ba60-551ab1cf86fc"
  },
  "version": 1,
  "createdBy": {
    "type": "PERSONNEL",
    "reference": {
      "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
    }
  },
  "createdAt": "2018-02-13T20:41:18.181Z",
  "updatedBy": {
    "type": "PERSONNEL",
    "reference": {
      "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
    }
  },
  "updatedAt": "2018-02-13T20:41:18.181Z"
}

PUT /strengths/{strengthId}

Updates a single strength.

Parameters

Parameter In Type Required Default Description Accepted Values
If-Match header string true N/A The ETag of a specific version of the strength to match against. -
strengthId path string true N/A The ID of the strength. -
body body putStrengths true N/A No description -

Response Statuses

Status Meaning Description Schema
200 OK Update a Strength Strength
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error
412 Precondition Failed Precondition Failed Error
428 Precondition Required Precondition Required Error

Response Headers

Status Header Type Format Description
200 ETag string The ETag of a specific version of the strength.

Retrieve a Single Strength

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/strengths/186ca582adf248aa8850edfb7dec38df', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/strengths/186ca582adf248aa8850edfb7dec38df \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "186ca582adf248aa8850edfb7dec38df",
  "consumer": {
    "id": "d8454f2a-665c-49d4-87db-8c167feae10e"
  },
  "description": "Walks several miles each day.",
  "startDate": "2018-07-04",
  "endDate": "2018-07-04",
  "status": "DOCUMENTED",
  "performedBy": {
    "display": "A A McCain",
    "type": "RELATED_PERSON"
  },
  "strengthDefinition": {
    "id": "186ca582adf248aa8850edfb7dec38df",
    "text": "Physically Active"
  },
  "originatingSourceEncounter": {
    "id": "09920f12-006f-44za-019d-12kdk23094ee1",
    "dataPartitionId": "4de3a1ab-5783-4e30-ba60-551ab1cf86fc"
  },
  "updatedSourceEncounter": {
    "id": "09920f12-006f-44za-019d-12kdk23094ee2",
    "dataPartitionId": "4de3a1ab-5783-4e30-ba60-551ab1cf86fc"
  },
  "version": 1,
  "createdBy": {
    "type": "PERSONNEL",
    "reference": {
      "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
    }
  },
  "createdAt": "2018-02-13T20:41:18.181Z",
  "updatedBy": {
    "type": "PERSONNEL",
    "reference": {
      "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
    }
  },
  "updatedAt": "2018-02-13T20:41:18.181Z"
}

GET /strengths/{strengthId}

Retrieves a single strength.

Parameters

Parameter In Type Required Default Description Accepted Values
strengthId path string true N/A The ID of the strength. -

Response Statuses

Status Meaning Description Schema
200 OK Retrieve a Single Strength Strength
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Response Headers

Status Header Type Format Description
200 ETag string The ETag of a specific version of the strength.

Strength Definitions

Strength definitions act as templates that can be referenced when creating a strength. The set of strength definitions form a catalog of content that can be searched, selected, and customized when first establishing a strength for an individual.

Create a Strength Definition

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/strength-definitions', headers: headers, body: {"text":"Optimism","status":"ACTIVE"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/strength-definitions \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"text":"Optimism","status":"ACTIVE"}

Example response

{
  "id": "186ca582adf248aa8850edfb7dec38df",
  "text": "Optimism",
  "status": "ACTIVE",
  "createdAt": "2018-04-20T15:27:47.123Z",
  "updatedAt": "2018-04-20T15:27:47.123Z"
}

POST /strength-definitions

Creates a strength definition.

Parameters

Parameter In Type Required Default Description Accepted Values
body body postStrengthDefinitions true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created Create a Strength Definition StrengthDefinition
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Response Headers

Status Header Type Format Description
201 ETag string The ETag of a specific version of the strength definition.

Retrieve a List of Strength Definitions

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/strength-definitions', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/strength-definitions \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "186ca582adf248aa8850edfb7dec38df",
      "text": "Optimism",
      "status": "ACTIVE",
      "createdAt": "2018-04-20T15:27:47.123Z",
      "updatedAt": "2018-04-20T15:27:47.123Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/strength-definitions?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/strength-definitions?offset=0&limit=20"
}

GET /strength-definitions

Retrieves a list of strength definitions.

Parameters

Parameter In Type Required Default Description Accepted Values
text query string false N/A Filters by the description of the strength definition. Partial matching of the text is supported. -
status query array[string] false N/A Filters by the strength definition status. ACTIVE, INACTIVE
id query array[string] false N/A Filters by the ID of the strength definition. -
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK Retrieve a List of Strength Definitions StrengthDefinitions
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Update a Strength Definition

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'If-Match' => {
  "type": "string"
}
} 

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/strength-definitions/186ca582adf248aa8850edfb7dec38df', headers: headers, body: {"text":"Optimism","status":"ACTIVE"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/strength-definitions/186ca582adf248aa8850edfb7dec38df \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \ \
-H 'If-Match: [object Object]' \
-d {"text":"Optimism","status":"ACTIVE"}

Example response

{
  "id": "186ca582adf248aa8850edfb7dec38df",
  "text": "Optimism",
  "status": "ACTIVE",
  "createdAt": "2018-04-20T15:27:47.123Z",
  "updatedAt": "2018-04-20T15:27:47.123Z"
}

PUT /strength-definitions/{strengthDefinitionId}

Updates a single strength definition.

Parameters

Parameter In Type Required Default Description Accepted Values
If-Match header string true N/A The ETag of a specific version of the strength definition to match against. -
strengthDefinitionId path string true N/A The ID of the strength definition. -
body body putStrengthDefinitions true N/A No description -

Response Statuses

Status Meaning Description Schema
200 OK Update a Strength Definition StrengthDefinition
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error
412 Precondition Failed Precondition Failed Error
428 Precondition Required Precondition Required Error

Response Headers

Status Header Type Format Description
200 ETag string The ETag of a specific version of the strength definition.

Retrieve a Single Strength Definition

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/strength-definitions/186ca582adf248aa8850edfb7dec38df', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/strength-definitions/186ca582adf248aa8850edfb7dec38df \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "186ca582adf248aa8850edfb7dec38df",
  "text": "Optimism",
  "status": "ACTIVE",
  "createdAt": "2018-04-20T15:27:47.123Z",
  "updatedAt": "2018-04-20T15:27:47.123Z"
}

GET /strength-definitions/{strengthDefinitionId}

Retrieves a single strength definition by ID.

Parameters

Parameter In Type Required Default Description Accepted Values
strengthDefinitionId path string true N/A The ID of the strength definition. -

Response Statuses

Status Meaning Description Schema
200 OK Retrieve a Single Strength Definition StrengthDefinition
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Response Headers

Status Header Type Format Description
200 ETag string The ETag of a specific version of the strength.

Measure Suggestion Definitions

A measure suggestion definition is a mapping between a plan entity and a HealtheRegistries measure that is not currently met. Registries and measures as derived from HealtheRegistries provide important guidance for a clinician to understand what metrics a person should be measured by and what actions remain to be completed for their care. A measure suggestion definition must be mapped to an activity definition, goal definition, or health concern definition to enable the addition of the measure to a person’s plan.

Create a Measure Suggestion Definition

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/measure-suggestion-definitions', headers: headers, body: {"population":{"id":"11a349gw2xky3d9e9q72633k4vt1d9w1"},"program":{"id":"11c3a7c39225c391387341c2aac323fds","measure":{"id":"11e8998c12b3bb9ebd7c1fbb695d35ec","outcome":"NOT_ACHIEVED"}},"measure":{"id":"11e8998c12b3bb9ebd7c1fbb695d35ec","outcome":"NOT_ACHIEVED"},"status":"ACCEPTED","planDefinition":{"id":"11e8902c9e2908c69718f13503066bee","type":"ACTIVITY_DEFINITION"},"planEntity":{"action":"CREATE","activity":{"status":"ACCEPTED"}},"programGroup":{"id":"11d819az2eda3d9f9c76653k4cc1d9f4"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/measure-suggestion-definitions \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"population":{"id":"11a349gw2xky3d9e9q72633k4vt1d9w1"},"program":{"id":"11c3a7c39225c391387341c2aac323fds","measure":{"id":"11e8998c12b3bb9ebd7c1fbb695d35ec","outcome":"NOT_ACHIEVED"}},"measure":{"id":"11e8998c12b3bb9ebd7c1fbb695d35ec","outcome":"NOT_ACHIEVED"},"status":"ACCEPTED","planDefinition":{"id":"11e8902c9e2908c69718f13503066bee","type":"ACTIVITY_DEFINITION"},"planEntity":{"action":"CREATE","activity":{"status":"ACCEPTED"}},"programGroup":{"id":"11d819az2eda3d9f9c76653k4cc1d9f4"}}

Example response

{
  "id": "11c819be2efb3d8f9c76653d4cc4a3f3",
  "population": {
    "id": "11a349gw2xky3d9e9q72633k4vt1d9w1"
  },
  "program": {
    "id": "11c3a7c39225c391387341c2aac323fds",
    "measure": {
      "id": "11e8998c12b3bb9ebd7c1fbb695d35ec",
      "outcome": "NOT_ACHIEVED"
    }
  },
  "status": "ACTIVE",
  "planDefinition": {
    "id": "11e8902c9e2908c69718f13503066bee",
    "type": "ACTIVITY_DEFINITION"
  },
  "planEntity": {
    "action": "CREATE",
    "activity": {
      "status": "ACCEPTED"
    }
  },
  "programGroup": {
    "id": "11d819az2eda3d9f9c76653k4cc1d9f4"
  },
  "createdAt": "2018-04-20T15:27:47.123Z",
  "updatedAt": "2018-04-20T15:27:47.123Z"
}

POST /measure-suggestion-definitions

Creates a measure suggestion definition.

Parameters

Parameter In Type Required Default Description Accepted Values
body body postMeasureSuggestionDefinitions true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created Create a Measure Suggestion Definition MeasureSuggestionDefinition
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Retrieve a List of Measure Suggestion Definitions

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/measure-suggestion-definitions', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/measure-suggestion-definitions \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "11c819be2efb3d8f9c76653d4cc4a3f3",
      "population": {
        "id": "11a349gw2xky3d9e9q72633k4vt1d9w1"
      },
      "program": {
        "id": "11c3a7c39225c391387341c2aac323fds",
        "measure": {
          "id": "11e8998c12b3bb9ebd7c1fbb695d35ec",
          "outcome": "NOT_ACHIEVED"
        }
      },
      "status": "ACTIVE",
      "planDefinition": {
        "id": "11e8902c9e2908c69718f13503066bee",
        "type": "ACTIVITY_DEFINITION"
      },
      "planEntity": {
        "action": "CREATE",
        "activity": {
          "status": "ACCEPTED"
        }
      },
      "programGroup": {
        "id": "11d819az2eda3d9f9c76653k4cc1d9f4"
      },
      "createdAt": "2018-04-20T15:27:47.123Z",
      "updatedAt": "2018-04-20T15:27:47.123Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/plan-suggestion/v1/measure-suggestion-definition?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/plan-suggestion/v1/measure-suggestion-definition?offset=0&limit=20"
}

GET /measure-suggestion-definitions

Retrieves a list of measure suggestion definitions.

Parameters

Parameter In Type Required Default Description Accepted Values
status query array[string] false N/A Filters the retrieved measure suggestion definitions by status. ACTIVE, INACTIVE
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK Retrieve a List of Measure Suggestion Definitions MeasureSuggestionDefinitions
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Retrieve a Single Measure Suggestion Definition

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/measure-suggestion-definitions/11c819be2efb3d8f9c76653d4cc4a3f3', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/measure-suggestion-definitions/11c819be2efb3d8f9c76653d4cc4a3f3 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "11c819be2efb3d8f9c76653d4cc4a3f3",
  "population": {
    "id": "11a349gw2xky3d9e9q72633k4vt1d9w1"
  },
  "program": {
    "id": "11c3a7c39225c391387341c2aac323fds",
    "measure": {
      "id": "11e8998c12b3bb9ebd7c1fbb695d35ec",
      "outcome": "NOT_ACHIEVED"
    }
  },
  "status": "ACTIVE",
  "planDefinition": {
    "id": "11e8902c9e2908c69718f13503066bee",
    "type": "ACTIVITY_DEFINITION"
  },
  "planEntity": {
    "action": "CREATE",
    "activity": {
      "status": "ACCEPTED"
    }
  },
  "programGroup": {
    "id": "11d819az2eda3d9f9c76653k4cc1d9f4"
  },
  "createdAt": "2018-04-20T15:27:47.123Z",
  "updatedAt": "2018-04-20T15:27:47.123Z"
}

GET /measure-suggestion-definitions/{measureSuggestionDefinitionId}

Retrieve a single measure suggestion definition.

Parameters

Parameter In Type Required Default Description Accepted Values
measureSuggestionDefinitionId path string true N/A The ID of a measure suggestion. -

Response Statuses

Status Meaning Description Schema
200 OK Retrieve a Single Measure Suggestion Definition MeasureSuggestionDefinition
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Updates a Measure Suggestion Definition

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/measure-suggestion-definitions/11c819be2efb3d8f9c76653d4cc4a3f3', headers: headers, body: {"population":{"id":"11a349gw2xky3d9e9q72633k4vt1d9w1"},"program":{"id":"11c3a7c39225c391387341c2aac323fds","measure":{"id":"11e8998c12b3bb9ebd7c1fbb695d35ec","outcome":"NOT_ACHIEVED"}},"measure":{"id":"11e8998c12b3bb9ebd7c1fbb695d35ec","outcome":"NOT_ACHIEVED"},"status":"ACCEPTED","planDefinition":{"id":"11e8902c9e2908c69718f13503066bee","type":"ACTIVITY_DEFINITION"},"planEntity":{"action":"CREATE","activity":{"status":"ACCEPTED"}},"programGroup":{"id":"11d819az2eda3d9f9c76653k4cc1d9f4"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/measure-suggestion-definitions/11c819be2efb3d8f9c76653d4cc4a3f3 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"population":{"id":"11a349gw2xky3d9e9q72633k4vt1d9w1"},"program":{"id":"11c3a7c39225c391387341c2aac323fds","measure":{"id":"11e8998c12b3bb9ebd7c1fbb695d35ec","outcome":"NOT_ACHIEVED"}},"measure":{"id":"11e8998c12b3bb9ebd7c1fbb695d35ec","outcome":"NOT_ACHIEVED"},"status":"ACCEPTED","planDefinition":{"id":"11e8902c9e2908c69718f13503066bee","type":"ACTIVITY_DEFINITION"},"planEntity":{"action":"CREATE","activity":{"status":"ACCEPTED"}},"programGroup":{"id":"11d819az2eda3d9f9c76653k4cc1d9f4"}}

PUT /measure-suggestion-definitions/{measureSuggestionDefinitionId}

Updates a measure suggestion definition.

Parameters

Parameter In Type Required Default Description Accepted Values
measureSuggestionDefinitionId path string true N/A The ID of a measure suggestion. -
body body putMeasureSuggestionDefinitions true N/A No description -

Response Statuses

Status Meaning Description Schema
200 OK Updates a Measure Suggestion Definition MeasureSuggestionDefinition
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Barrier Definitions

Barrier definitions act as templates that can be referenced when creating barriers that are associated to a goal. The set of barrier definitions form a catalog of content that can be searched, selected, and customized when first establishing a goal barrier for an individual.

Retrieve a List of Barrier Definitions

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/barrier-definitions', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/barrier-definitions \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "11e8901dafad94f7a9b701d255a00ad0",
      "version": 1,
      "status": "ACTIVE",
      "code": {
        "text": "Living in poverty",
        "codings": [
          {
            "code": "11403006",
            "system": "2.16.840.1.113883.6.96"
          }
        ]
      },
      "concept": {
        "contextId": "37686A3F9C66452ABA66803ECC144344",
        "conceptAlias": "LIVING_IN_POVERTY_CLIN"
      },
      "createdAt": "2018-07-25T17:03:14.120Z",
      "updatedAt": "2018-07-25T17:03:14.120Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/barrier-definitions?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/barrier-definitions?offset=0&limit=20"
}

GET /barrier-definitions

Retrieves a list of barrier definitions.

Parameters

Parameter In Type Required Default Description Accepted Values
text query string false N/A Filters the retrieved barrier definitions by the specified text. Partial matching is allowed. -
status query array[string] false N/A Filters the retrieved barrier definitions by status. INACTIVE, ACTIVE
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK Retrieve a List of Barrier Definitions BarrierDefinitions
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Create a Barrier Definition

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/barrier-definitions', headers: headers, body: {"code":{"text":"Living in poverty","codings":[{"code":"11403006","system":"2.16.840.1.113883.6.96"}]},"status":"ACTIVE","concept":{"contextId":"37686A3F9C66452ABA66803ECC144344","conceptAlias":"LIVING_IN_POVERTY_CLIN"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/barrier-definitions \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"code":{"text":"Living in poverty","codings":[{"code":"11403006","system":"2.16.840.1.113883.6.96"}]},"status":"ACTIVE","concept":{"contextId":"37686A3F9C66452ABA66803ECC144344","conceptAlias":"LIVING_IN_POVERTY_CLIN"}}

Example response

{
  "id": "11e8901dafad94f7a9b701d255a00ad0",
  "version": 1,
  "status": "ACTIVE",
  "code": {
    "text": "Living in poverty",
    "codings": [
      {
        "code": "11403006",
        "system": "2.16.840.1.113883.6.96"
      }
    ]
  },
  "concept": {
    "contextId": "37686A3F9C66452ABA66803ECC144344",
    "conceptAlias": "LIVING_IN_POVERTY_CLIN"
  },
  "createdAt": "2018-07-25T17:03:14.120Z",
  "updatedAt": "2018-07-25T17:03:14.120Z"
}

POST /barrier-definitions

Creates a barrier definition.

Parameters

Parameter In Type Required Default Description Accepted Values
body body postBarrierDefinitions true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created Create a Barrier Definition BarrierDefinition
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Response Headers

Status Header Type Format Description
201 ETag string The ETag of a specific version of the barrier definition.

Update a Barrier Definition

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/barrier-definitions/11e8591a4d5e569c8f673f9b3f4603ec', headers: headers, body: {"code":{"text":"Living in poverty","codings":[{"code":"11403006","system":"2.16.840.1.113883.6.96"}]},"status":"ACTIVE","concept":{"contextId":"37686A3F9C66452ABA66803ECC144344","conceptAlias":"LIVING_IN_POVERTY_CLIN"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/barrier-definitions/11e8591a4d5e569c8f673f9b3f4603ec \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"code":{"text":"Living in poverty","codings":[{"code":"11403006","system":"2.16.840.1.113883.6.96"}]},"status":"ACTIVE","concept":{"contextId":"37686A3F9C66452ABA66803ECC144344","conceptAlias":"LIVING_IN_POVERTY_CLIN"}}

Example response

{
  "id": "11e8901dafad94f7a9b701d255a00ad0",
  "version": 1,
  "status": "ACTIVE",
  "code": {
    "text": "Living in poverty",
    "codings": [
      {
        "code": "11403006",
        "system": "2.16.840.1.113883.6.96"
      }
    ]
  },
  "concept": {
    "contextId": "37686A3F9C66452ABA66803ECC144344",
    "conceptAlias": "LIVING_IN_POVERTY_CLIN"
  },
  "createdAt": "2018-07-25T17:03:14.120Z",
  "updatedAt": "2018-07-25T17:03:14.120Z"
}

PUT /barrier-definitions/{barrierDefinitionId}

Updates a single barrier definition.

Parameters

Parameter In Type Required Default Description Accepted Values
barrierDefinitionId path integer(int32) true N/A No description -
body body putBarrierDefinitions true N/A No description -

Response Statuses

Status Meaning Description Schema
200 OK Update a Barrier Definition BarrierDefinition
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error
412 Precondition Failed Precondition Failed Error
428 Precondition Required Precondition Required Error

Response Headers

Status Header Type Format Description
200 ETag string The ETag of a specific version of the Barrier Definition.

Retrieve a Single Barrier Definition

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/barrier-definitions/11e8902c9e2908c69718f13503066bee', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/barrier-definitions/11e8902c9e2908c69718f13503066bee \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "11e8901dafad94f7a9b701d255a00ad0",
  "version": 1,
  "status": "ACTIVE",
  "code": {
    "text": "Living in poverty",
    "codings": [
      {
        "code": "11403006",
        "system": "2.16.840.1.113883.6.96"
      }
    ]
  },
  "concept": {
    "contextId": "37686A3F9C66452ABA66803ECC144344",
    "conceptAlias": "LIVING_IN_POVERTY_CLIN"
  },
  "createdAt": "2018-07-25T17:03:14.120Z",
  "updatedAt": "2018-07-25T17:03:14.120Z"
}

GET /barrier-definitions/{barrierDefinitionId}

Retrieves a single barrier definition by ID.

Parameters

Parameter In Type Required Default Description Accepted Values
barrierDefinitionId path string true N/A The ID of a barrier definition. -

Response Statuses

Status Meaning Description Schema
200 OK Retrieve a Single Barrier Definition BarrierDefinition
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Response Headers

Status Header Type Format Description
200 ETag string The ETag of a specific version of the barrier definition.

Schema Definitions

ActivityDefinition

Name Type Required Description Accepted Values
id string true The ID of the activity definition. -
text string true The short textual description of the activity definition. -
status string true The current status of the activity definition. The following statuses are possible:
- ACTIVE: Indicates that the definition can be used when adding the resource to the plan.
- INACTIVE: Indicates that the definition cannot be used when adding the resource to the plan.
ACTIVE, INACTIVE
categories [Category] false A list of category objects. -
disciplines [Discipline] false A list of discipline objects. -
coding [Coding] false A list of coding objects. -
description string false The detailed description of the activity definition. -
instantiatesUrl string false The URL pointing to an externally maintained activity definition. -
targets [TargetDefinition] false Targets can be used to measure goals and activities for completion, compliance, and progress. They can be Boolean values, numeric values, or ranges of high to low values. -
supportingExternalReferences [SupportingExternalReference] false References to items that exist outside of HealtheIntent and would support the progressionor completion of the activity. Note that an externalSupportingReferencedoes not provide all the information required for a system that uses this API to locate andretrieve the item referenced. Due to this, systems that use anexternalSupportingReference need prior knowledge and coordination with the systemthat contains the externalSupportingReference to understand how to retrieve theinformation about the item referenced. -
supportingReferences [SupportingReference] false References to items that exist in HealtheIntent and would support the progression orcompletion of the activity. -

Category

Name Type Required Description Accepted Values
id string true The ID of the category. -
text string true A textual description for the category. -
status string true The current status of the category. The following statuses are possible:
- ACTIVE: Indicates that the category is active and can be assigned to a resource.
- INACTIVE: Indicates that the category is inactive and cannot be assigned to a resource.
ACTIVE, INACTIVE
coding [Coding] false A list of coding objects. -
version integer(int32) true The current version of the category. The version must be sent in an If-Match header when updating the category. -

Coding

Name Type Required Description Accepted Values
code string true The ID of the code. -
display string false The human-readable representation of the code. -
system string true The ID of the coding system that gives meaning to the code. -

Discipline

Name Type Required Description Accepted Values
id string true The ID of the discipline. -
text string true A textual description for the discipline. -
status string true The current status of the discipline. The following statuses are possible:
- ACTIVE: Indicates that the discipline is active and can be assigned to a resource.
- INACTIVE: Indicates that the discipline is inactive and cannot be assigned to a resource.
ACTIVE, INACTIVE
coding [Coding] false A list of coding objects. -
version integer(int32) true The current version of the discipline. The version must be sent in an If-Match header when updating the discipline. -

TargetDefinition

Name Type Required Description Accepted Values
measureTypeDescription string false A textual description of the measure type. The maximum length is 1,000 characters. -
measureType TargetMeasureType true The type of parameter that is being tracked, for example, body weight, blood pressure, or hemoglobin A1c level. The parameter is a reference to an ontology context and concept. -
detail TargetDetailDefinition true The target value of the measure that must be achieved to indicate that the goal or activity is fulfilled. This can be a Boolean value, numeric value, or range of high to low values. -

TargetMeasureType

Name Type Required Description Accepted Values
contextId string true The ID of the context for the measure type. The maximum length is 60 characters. -
conceptAlias string true The alias of the concept in the context for the measure type.The maximum length is 1,000 characters. -

TargetDetailDefinition

Name Type Required Description Accepted Values
type string true Indicates the type of detail provided. BOOLEAN, NUMERIC, RANGE
boolean TargetBoolean false Indicates that the fulfillment of the goal or activity can be measured by the presence of the Boolean value. -
numeric TargetNumericDefinition false Indicates that the goal or activity can be achieved based on the numeric value. -
range TargetRangeDefinition false Indicates that the goal or activity can be achieved based on the numeric boundaries of the range. -

TargetBoolean

Name Type Required Description Accepted Values
value string true Indicates whether the measure type should be met. TRUE, FALSE

TargetNumericDefinition

Name Type Required Description Accepted Values
value number(double) false The numeric value of the measure type, which can include a decimal. The value must be greater than or equal to 0 and must have no more than 6 digits on either side of the decimal. -
operator string true The operator that indicates how the measure type value can be evaluated. >, <, >=, <=, =
unitDescription string false A textual description of the unit measure. The maximum length is 1,000 characters. -
unit TargetUnitDefinition false The unit of measure for the numeric value. -

TargetUnitDefinition

Name Type Required Description Accepted Values
contextId string true The ID of the context for the unit of measure. The maximum length is 60 characters. -
conceptAlias string true The alias of the concept in the context for the unit of measure.The maximum length is 1,000 characters. -

TargetRangeDefinition

Name Type Required Description Accepted Values
high number(double) false The inclusive upper boundary of the range, which can include a decimal. The value must be greater than or equal to 0 and must have no more than 6 digits on either side of the decimal. -
low number(double) false The inclusive lower boundary of the range, which can include a decimal. The value must be greater than or equal to 0 and must have no more than 6 digits on either side of the decimal. -
unitDescription string false A textual description of the unit measure. The maximum length is 1,000 characters. -
unit TargetUnitDefinition false The unit of measure for the range values. -

SupportingExternalReference

Name Type Required Description Accepted Values
system string true The namespace that contains the resource. -
id string true The ID of the resource in the system namespace. -

SupportingReference

Name Type Required Description Accepted Values
kind string true A description of the type of referenced resource. -
id string true The ID of the resource in HealtheIntent. -

ActivityDefinitionTemplate

Name Type Required Description Accepted Values
id string true The ID of the activity definition. -

GoalDefinition

Name Type Required Description Accepted Values
id string true The ID of the goal definition. -
text string true The short textual description of the goal definition. -
status string true The current status of the activity definition. The following statuses are possible:
- ACTIVE: Indicates that the definition can be used when adding the resource to the plan.
- INACTIVE: Indicates that the definition cannot be used when adding the resource to the plan.
ACTIVE, INACTIVE
categories [Category] false A list of category objects. -
disciplines [Discipline] false A list of discipline objects. -
coding [Coding] false A list of coding objects. -
targets [TargetDefinition] false Targets can be used to measure goals and activities for completion, compliance, and progress. They can be Boolean values, numeric values, or ranges of high to low values. -

GoalDefinitionTemplate

Name Type Required Description Accepted Values
id string true The ID of the goal definition. -
activityDefinitions [ActivityDefinitionTemplate] false The activity definitions representing the activities that support this goal in the context of this plan template. -
shortTermGoalDefinitions [ShortTermGoalDefinitionTemplate] false The activity definitions representing the activities that support this goal in the context of this plan template. -

ShortTermGoalDefinitionTemplate

Name Type Required Description Accepted Values
id string true The ID of the goal definition. -
activityDefinitions [ActivityDefinitionTemplate] false The activity definitions representing the activities that support this goal in the context of this plan template. -

HealthConcernDefinitionTemplate

Name Type Required Description Accepted Values
id string true The ID of the health concern definition. -
goalDefinitions [GoalDefinitionTemplate] false The goal definitions representing the goals that support this health concern in the context of this plan template. -
activityDefinitions [ActivityDefinitionTemplate] false The activity definitions representing the activities that support this health concern in the context of this plan template. -

PlanTemplate

Name Type Required Description Accepted Values
id string true The ID of the longitudinal plan template. -
healthConcernDefinitions [HealthConcernDefinitionTemplate] false The health concern definitions representing the health concerns that are contained in this plan template. -
goalDefinitions [GoalDefinitionTemplate] false The goal definitions representing the goals that are contained in this plan template. -
createdAt string true The date and time when the plan template was initially entered into the system. In ISO 8601 formatting with precision ranging up to the millisecond (YYYY-MM-DDTHH:mm:ss.sssZ), for example, 2018-02-13T20:41:18.181Z. The time in this field is set automatically when the plan template is first created; therefore, the field does not need to be set explicitly. -
updatedAt string true The date and time when the plan template was was last modified. In ISO 8601 formatting with precision ranging up to the millisecond (YYYY-MM-DDTHH:mm:ss.sssZ), for example, 2018-02-13T20:41:18.181Z. The time in this field is set automatically every time the plan template is modified; therefore, the field does not need to be set explicitly. -
description string true A textual description of the plan template. The maximum length is 1000 characters. -
status string true The current status of the plan template. ACTIVE, INACTIVE

StrengthDefinition

Name Type Required Description Accepted Values
id string true The ID of the strength definition. -
text string true A textual description of the strength definition. -