NAV Navbar
Logo cerner
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 towards, 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.

URL: https://cernerdemo.api.us.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.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.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.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.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.healtheintent.com/longitudinal-plan/v1/plan-templates?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.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.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.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.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.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.

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 in order 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.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.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.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.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.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.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.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.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.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.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.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.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.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.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",
      "consumer": {
        "id": "d8454f2a-665c-49d4-87db-8c167feae10e"
      },
      "description": "Pain maintained at or below acceptable pain rating",
      "version": 1,
      "startDate": "2017-12-04",
      "dueDate": "2017-12-20",
      "status": "IN_PROGRESS",
      "statusReason": "Pain maintenance has been done",
      "progress": "PROGRESSING",
      "targets": [
        {
          "measureType": {
            "contextId": "6edf9160-1741-4538-97b1-cf0c2a557b16",
            "conceptAlias": "HYPERTENSION_CLIN_DIA"
          },
          "detail": {
            "range": {
              "high": "80",
              "low": "70"
            }
          }
        },
        {
          "measureType": {
            "contextId": "58c88d96-7ad0-4bfe-92d0-de52fca87642",
            "conceptAlias": "HYPERTENSION_CLIN_SYS"
          },
          "detail": {
            "range": {
              "high": "130",
              "low": "120"
            }
          }
        }
      ],
      "goalDefinition": {
        "id": "11e8902c5fe1e3238afa990c2154a1a3",
        "text": "Cardiovascular Type 1"
      },
      "createdAt": "2018-07-25T17:03:14.120Z",
      "updatedAt": "2018-07-25T17:03:14.120Z",
      "createdBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "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"
      },
      "priority": 1,
      "shortTermGoals": [
        {
          "id": "22e8902c79c4ee348fe5cf0da3dac656"
        }
      ],
      "longTermGoals": [
        {
          "id": "11e8902c79c4ee348fe5cf0da3dac545"
        }
      ],
      "healthConcerns": [
        {
          "id": "2f978977-4c67-448a-883b-5bbe8ca47bbd"
        }
      ],
      "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"
            }
          }
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/activities/11e8902c9e2908c69718f13503066bee/goals?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.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. -
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. -
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.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.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.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.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.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.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.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.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.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/activities/11e8902c9e2908c69718f13503066bee/notes?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.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. -
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.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/activities/11e8902c9e2908c69718f13503066bee', headers: headers, body: {"startDate":"2015-01-02","endDate":"2019-01-02","targets":[{"measureType":{"contextId":"fd597b7c-690f-4158-93d5-bf8030e653f3","conceptAlias":"SCREENING_FOR_FUTURE_FALLS_RISK"},"detail":{"boolean":{"value":"TRUE"}}}],"statusReason":"Activity has been accepted","performers":[{"reference":{"id":"9cf249e6-9c5d-4d8a-a54a-46a6aabe3729"},"type":"PERSONNEL"}],"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"}],"description":"Daily weight monitoring using diary","status":"ACCEPTED","categories":[{"id":"11e818be2efb3d8f9c76653d4cc4a3f3"},{"id":"11e831f1150a0ec3a8a26933567de562"}],"disciplines":[{"id":"11c3a811c3900dc297c384c393c2bac2"},{"id":"11e8642c933ae8f48d534375f1bbef93"}],"schedule":{"frequency":1,"period":1,"periodUnit":"D","duration":1,"durationUnit":"D"},"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.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 {"startDate":"2015-01-02","endDate":"2019-01-02","targets":[{"measureType":{"contextId":"fd597b7c-690f-4158-93d5-bf8030e653f3","conceptAlias":"SCREENING_FOR_FUTURE_FALLS_RISK"},"detail":{"boolean":{"value":"TRUE"}}}],"statusReason":"Activity has been accepted","performers":[{"reference":{"id":"9cf249e6-9c5d-4d8a-a54a-46a6aabe3729"},"type":"PERSONNEL"}],"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"}],"description":"Daily weight monitoring using diary","status":"ACCEPTED","categories":[{"id":"11e818be2efb3d8f9c76653d4cc4a3f3"},{"id":"11e831f1150a0ec3a8a26933567de562"}],"disciplines":[{"id":"11c3a811c3900dc297c384c393c2bac2"},{"id":"11e8642c933ae8f48d534375f1bbef93"}],"schedule":{"frequency":1,"period":1,"periodUnit":"D","duration":1,"durationUnit":"D"},"updatedBy":{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}}}

Example response

{
  "id": "11e8902c9e2908c69718f13503066bee",
  "description": "Daily weight monitoring using diary",
  "version": 1,
  "startDate": "2015-01-02",
  "endDate": "2019-01-02",
  "status": "ACCEPTED",
  "schedule": {
    "frequency": 1,
    "period": 1,
    "periodUnit": "D",
    "duration": 1,
    "durationUnit": "D"
  },
  "targets": [
    {
      "measureType": {
        "contextId": "6edf9160-1741-4538-97b1-cf0c2a557b16",
        "conceptAlias": "SCREENING_FOR_FUTURE_FALLS_RISK"
      },
      "detail": {
        "boolean": {
          "value": "TRUE"
        }
      }
    }
  ],
  "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",
  "activityDefinition": {
    "id": "11e8902c5fe1e3238afa990c2154a1a3",
    "text": "Cardiovascular Type 1"
  },
  "createdBy": {
    "type": "PERSONNEL",
    "reference": {
      "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
    }
  },
  "createdAt": "2018-07-25T17:03:14.120Z",
  "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"
  },
  "healthConcerns": [
    {
      "id": "2f978977-4c67-448a-883b-5bbe8ca47bbd"
    }
  ],
  "goals": [
    {
      "id": "81d550d0-4569-49c5-bb08-28a8a5a34926"
    }
  ],
  "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.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.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",
  "version": 1,
  "startDate": "2015-01-02",
  "endDate": "2019-01-02",
  "status": "ACCEPTED",
  "schedule": {
    "frequency": 1,
    "period": 1,
    "periodUnit": "D",
    "duration": 1,
    "durationUnit": "D"
  },
  "targets": [
    {
      "measureType": {
        "contextId": "6edf9160-1741-4538-97b1-cf0c2a557b16",
        "conceptAlias": "SCREENING_FOR_FUTURE_FALLS_RISK"
      },
      "detail": {
        "boolean": {
          "value": "TRUE"
        }
      }
    }
  ],
  "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",
  "activityDefinition": {
    "id": "11e8902c5fe1e3238afa990c2154a1a3",
    "text": "Cardiovascular Type 1"
  },
  "createdBy": {
    "type": "PERSONNEL",
    "reference": {
      "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
    }
  },
  "createdAt": "2018-07-25T17:03:14.120Z",
  "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"
  },
  "healthConcerns": [
    {
      "id": "2f978977-4c67-448a-883b-5bbe8ca47bbd"
    }
  ],
  "goals": [
    {
      "id": "81d550d0-4569-49c5-bb08-28a8a5a34926"
    }
  ],
  "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.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/activities', headers: headers, body: {"startDate":"2015-01-02","endDate":"2019-01-02","targets":[{"measureType":{"contextId":"fd597b7c-690f-4158-93d5-bf8030e653f3","conceptAlias":"SCREENING_FOR_FUTURE_FALLS_RISK"},"detail":{"boolean":{"value":"TRUE"}}}],"statusReason":"Activity has been accepted","performers":[{"reference":{"id":"9cf249e6-9c5d-4d8a-a54a-46a6aabe3729"},"type":"PERSONNEL"}],"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"}],"description":"Daily weight monitoring using diary","status":"ACCEPTED","categories":[{"id":"11e818be2efb3d8f9c76653d4cc4a3f3"},{"id":"11e831f1150a0ec3a8a26933567de562"}],"disciplines":[{"id":"11c3a811c3900dc297c384c393c2bac2"},{"id":"11e8642c933ae8f48d534375f1bbef93"}],"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"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.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 {"startDate":"2015-01-02","endDate":"2019-01-02","targets":[{"measureType":{"contextId":"fd597b7c-690f-4158-93d5-bf8030e653f3","conceptAlias":"SCREENING_FOR_FUTURE_FALLS_RISK"},"detail":{"boolean":{"value":"TRUE"}}}],"statusReason":"Activity has been accepted","performers":[{"reference":{"id":"9cf249e6-9c5d-4d8a-a54a-46a6aabe3729"},"type":"PERSONNEL"}],"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"}],"description":"Daily weight monitoring using diary","status":"ACCEPTED","categories":[{"id":"11e818be2efb3d8f9c76653d4cc4a3f3"},{"id":"11e831f1150a0ec3a8a26933567de562"}],"disciplines":[{"id":"11c3a811c3900dc297c384c393c2bac2"},{"id":"11e8642c933ae8f48d534375f1bbef93"}],"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"}}

Example response

{
  "id": "11e8902c9e2908c69718f13503066bee",
  "description": "Daily weight monitoring using diary",
  "version": 1,
  "startDate": "2015-01-02",
  "endDate": "2019-01-02",
  "status": "ACCEPTED",
  "schedule": {
    "frequency": 1,
    "period": 1,
    "periodUnit": "D",
    "duration": 1,
    "durationUnit": "D"
  },
  "targets": [
    {
      "measureType": {
        "contextId": "6edf9160-1741-4538-97b1-cf0c2a557b16",
        "conceptAlias": "SCREENING_FOR_FUTURE_FALLS_RISK"
      },
      "detail": {
        "boolean": {
          "value": "TRUE"
        }
      }
    }
  ],
  "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",
  "activityDefinition": {
    "id": "11e8902c5fe1e3238afa990c2154a1a3",
    "text": "Cardiovascular Type 1"
  },
  "createdBy": {
    "type": "PERSONNEL",
    "reference": {
      "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
    }
  },
  "createdAt": "2018-07-25T17:03:14.120Z",
  "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"
  },
  "healthConcerns": [
    {
      "id": "2f978977-4c67-448a-883b-5bbe8ca47bbd"
    }
  ],
  "goals": [
    {
      "id": "81d550d0-4569-49c5-bb08-28a8a5a34926"
    }
  ],
  "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

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.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.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",
      "version": 1,
      "startDate": "2015-01-02",
      "endDate": "2019-01-02",
      "status": "ACCEPTED",
      "schedule": {
        "frequency": 1,
        "period": 1,
        "periodUnit": "D",
        "duration": 1,
        "durationUnit": "D"
      },
      "targets": [
        {
          "measureType": {
            "contextId": "6edf9160-1741-4538-97b1-cf0c2a557b16",
            "conceptAlias": "SCREENING_FOR_FUTURE_FALLS_RISK"
          },
          "detail": {
            "boolean": {
              "value": "TRUE"
            }
          }
        }
      ],
      "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",
      "activityDefinition": {
        "id": "11e8902c5fe1e3238afa990c2154a1a3",
        "text": "Cardiovascular Type 1"
      },
      "createdBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "createdAt": "2018-07-25T17:03:14.120Z",
      "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"
      },
      "healthConcerns": [
        {
          "id": "2f978977-4c67-448a-883b-5bbe8ca47bbd"
        }
      ],
      "goals": [
        {
          "id": "81d550d0-4569-49c5-bb08-28a8a5a34926"
        }
      ],
      "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.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/activities?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.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. 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. -
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 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 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 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.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.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.healtheintent.com/longitudinal-plan/v1/activities/11e8902c9e2908c69718f13503066bee/status-history?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.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

Goals

A goal is a desired outcome towards 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 within 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 in order 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 in order 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.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.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.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.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.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.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",
      "consumer": {
        "id": "d8454f2a-665c-49d4-87db-8c167feae10e"
      },
      "description": "Pain maintained at or below acceptable pain rating",
      "version": 1,
      "startDate": "2017-12-04",
      "dueDate": "2017-12-20",
      "status": "IN_PROGRESS",
      "statusReason": "Pain maintenance has been done",
      "progress": "PROGRESSING",
      "targets": [
        {
          "measureType": {
            "contextId": "6edf9160-1741-4538-97b1-cf0c2a557b16",
            "conceptAlias": "HYPERTENSION_CLIN_DIA"
          },
          "detail": {
            "range": {
              "high": "80",
              "low": "70"
            }
          }
        },
        {
          "measureType": {
            "contextId": "58c88d96-7ad0-4bfe-92d0-de52fca87642",
            "conceptAlias": "HYPERTENSION_CLIN_SYS"
          },
          "detail": {
            "range": {
              "high": "130",
              "low": "120"
            }
          }
        }
      ],
      "goalDefinition": {
        "id": "11e8902c5fe1e3238afa990c2154a1a3",
        "text": "Cardiovascular Type 1"
      },
      "createdAt": "2018-07-25T17:03:14.120Z",
      "updatedAt": "2018-07-25T17:03:14.120Z",
      "createdBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "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"
      },
      "priority": 1,
      "shortTermGoals": [
        {
          "id": "22e8902c79c4ee348fe5cf0da3dac656"
        }
      ],
      "longTermGoals": [
        {
          "id": "11e8902c79c4ee348fe5cf0da3dac545"
        }
      ],
      "healthConcerns": [
        {
          "id": "2f978977-4c67-448a-883b-5bbe8ca47bbd"
        }
      ],
      "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"
            }
          }
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.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.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. -
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. -
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.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.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.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.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.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.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.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.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.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.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",
      "version": 1,
      "startDate": "2015-01-02",
      "endDate": "2019-01-02",
      "status": "ACCEPTED",
      "schedule": {
        "frequency": 1,
        "period": 1,
        "periodUnit": "D",
        "duration": 1,
        "durationUnit": "D"
      },
      "targets": [
        {
          "measureType": {
            "contextId": "6edf9160-1741-4538-97b1-cf0c2a557b16",
            "conceptAlias": "SCREENING_FOR_FUTURE_FALLS_RISK"
          },
          "detail": {
            "boolean": {
              "value": "TRUE"
            }
          }
        }
      ],
      "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",
      "activityDefinition": {
        "id": "11e8902c5fe1e3238afa990c2154a1a3",
        "text": "Cardiovascular Type 1"
      },
      "createdBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "createdAt": "2018-07-25T17:03:14.120Z",
      "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"
      },
      "healthConcerns": [
        {
          "id": "2f978977-4c67-448a-883b-5bbe8ca47bbd"
        }
      ],
      "goals": [
        {
          "id": "81d550d0-4569-49c5-bb08-28a8a5a34926"
        }
      ],
      "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.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/goals/11e8a1694dd8ec288d589d6a17a6f9d6/activities?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.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. -
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 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 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.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.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.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.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.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.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.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.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.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/goals/11e8902c9e2908c69718f13503066bee/notes?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.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. -
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.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","targets":[{"measureType":{"contextId":"fd597b7c-690f-4158-93d5-bf8030e653f3","conceptAlias":"SCREENING_FOR_FUTURE_FALLS_RISK"},"detail":{"boolean":{"value":"TRUE"}}}],"owners":[{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}}],"priority":1,"description":"Pain maintained at or below acceptable pain rating","status":"IN_PROGRESS","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"}}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us.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","targets":[{"measureType":{"contextId":"fd597b7c-690f-4158-93d5-bf8030e653f3","conceptAlias":"SCREENING_FOR_FUTURE_FALLS_RISK"},"detail":{"boolean":{"value":"TRUE"}}}],"owners":[{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}}],"priority":1,"description":"Pain maintained at or below acceptable pain rating","status":"IN_PROGRESS","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"}}}

Example response

{
  "id": "11e8591a4d5e569c8f673f9b3f4603ec",
  "consumer": {
    "id": "d8454f2a-665c-49d4-87db-8c167feae10e"
  },
  "description": "Pain maintained at or below acceptable pain rating",
  "version": 1,
  "startDate": "2017-12-04",
  "dueDate": "2017-12-20",
  "status": "IN_PROGRESS",
  "statusReason": "Pain maintenance has been done",
  "progress": "PROGRESSING",
  "targets": [
    {
      "measureType": {
        "contextId": "6edf9160-1741-4538-97b1-cf0c2a557b16",
        "conceptAlias": "HYPERTENSION_CLIN_DIA"
      },
      "detail": {
        "range": {
          "high": "80",
          "low": "70"
        }
      }
    },
    {
      "measureType": {
        "contextId": "58c88d96-7ad0-4bfe-92d0-de52fca87642",
        "conceptAlias": "HYPERTENSION_CLIN_SYS"
      },
      "detail": {
        "range": {
          "high": "130",
          "low": "120"
        }
      }
    }
  ],
  "goalDefinition": {
    "id": "11e8902c5fe1e3238afa990c2154a1a3",
    "text": "Cardiovascular Type 1"
  },
  "createdAt": "2018-07-25T17:03:14.120Z",
  "updatedAt": "2018-07-25T17:03:14.120Z",
  "createdBy": {
    "type": "PERSONNEL",
    "reference": {
      "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
    }
  },
  "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"
  },
  "priority": 1,
  "shortTermGoals": [
    {
      "id": "22e8902c79c4ee348fe5cf0da3dac656"
    }
  ],
  "longTermGoals": [
    {
      "id": "11e8902c79c4ee348fe5cf0da3dac545"
    }
  ],
  "healthConcerns": [
    {
      "id": "2f978977-4c67-448a-883b-5bbe8ca47bbd"
    }
  ],
  "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"
        }
      }
    }
  ]
}

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.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","targets":[{"measureType":{"contextId":"fd597b7c-690f-4158-93d5-bf8030e653f3","conceptAlias":"SCREENING_FOR_FUTURE_FALLS_RISK"},"detail":{"boolean":{"value":"TRUE"}}}],"owners":[{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}}],"priority":1,"description":"Pain maintained at or below acceptable pain rating","status":"IN_PROGRESS","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"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.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","targets":[{"measureType":{"contextId":"fd597b7c-690f-4158-93d5-bf8030e653f3","conceptAlias":"SCREENING_FOR_FUTURE_FALLS_RISK"},"detail":{"boolean":{"value":"TRUE"}}}],"owners":[{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}}],"priority":1,"description":"Pain maintained at or below acceptable pain rating","status":"IN_PROGRESS","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"}}

Example response

{
  "id": "11e8591a4d5e569c8f673f9b3f4603ec",
  "consumer": {
    "id": "d8454f2a-665c-49d4-87db-8c167feae10e"
  },
  "description": "Pain maintained at or below acceptable pain rating",
  "version": 1,
  "startDate": "2017-12-04",
  "dueDate": "2017-12-20",
  "status": "IN_PROGRESS",
  "statusReason": "Pain maintenance has been done",
  "progress": "PROGRESSING",
  "targets": [
    {
      "measureType": {
        "contextId": "6edf9160-1741-4538-97b1-cf0c2a557b16",
        "conceptAlias": "HYPERTENSION_CLIN_DIA"
      },
      "detail": {
        "range": {
          "high": "80",
          "low": "70"
        }
      }
    },
    {
      "measureType": {
        "contextId": "58c88d96-7ad0-4bfe-92d0-de52fca87642",
        "conceptAlias": "HYPERTENSION_CLIN_SYS"
      },
      "detail": {
        "range": {
          "high": "130",
          "low": "120"
        }
      }
    }
  ],
  "goalDefinition": {
    "id": "11e8902c5fe1e3238afa990c2154a1a3",
    "text": "Cardiovascular Type 1"
  },
  "createdAt": "2018-07-25T17:03:14.120Z",
  "updatedAt": "2018-07-25T17:03:14.120Z",
  "createdBy": {
    "type": "PERSONNEL",
    "reference": {
      "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
    }
  },
  "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"
  },
  "priority": 1,
  "shortTermGoals": [
    {
      "id": "22e8902c79c4ee348fe5cf0da3dac656"
    }
  ],
  "longTermGoals": [
    {
      "id": "11e8902c79c4ee348fe5cf0da3dac545"
    }
  ],
  "healthConcerns": [
    {
      "id": "2f978977-4c67-448a-883b-5bbe8ca47bbd"
    }
  ],
  "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"
        }
      }
    }
  ]
}

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

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.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.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",
      "consumer": {
        "id": "d8454f2a-665c-49d4-87db-8c167feae10e"
      },
      "description": "Pain maintained at or below acceptable pain rating",
      "version": 1,
      "startDate": "2017-12-04",
      "dueDate": "2017-12-20",
      "status": "IN_PROGRESS",
      "statusReason": "Pain maintenance has been done",
      "progress": "PROGRESSING",
      "targets": [
        {
          "measureType": {
            "contextId": "6edf9160-1741-4538-97b1-cf0c2a557b16",
            "conceptAlias": "HYPERTENSION_CLIN_DIA"
          },
          "detail": {
            "range": {
              "high": "80",
              "low": "70"
            }
          }
        },
        {
          "measureType": {
            "contextId": "58c88d96-7ad0-4bfe-92d0-de52fca87642",
            "conceptAlias": "HYPERTENSION_CLIN_SYS"
          },
          "detail": {
            "range": {
              "high": "130",
              "low": "120"
            }
          }
        }
      ],
      "goalDefinition": {
        "id": "11e8902c5fe1e3238afa990c2154a1a3",
        "text": "Cardiovascular Type 1"
      },
      "createdAt": "2018-07-25T17:03:14.120Z",
      "updatedAt": "2018-07-25T17:03:14.120Z",
      "createdBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "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"
      },
      "priority": 1,
      "shortTermGoals": [
        {
          "id": "22e8902c79c4ee348fe5cf0da3dac656"
        }
      ],
      "longTermGoals": [
        {
          "id": "11e8902c79c4ee348fe5cf0da3dac545"
        }
      ],
      "healthConcerns": [
        {
          "id": "2f978977-4c67-448a-883b-5bbe8ca47bbd"
        }
      ],
      "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"
            }
          }
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/goals?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/goals?offset=0&limit=20"
}

GET /consumers/{consumerId}/goals

Retrieves a list of goals. 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. -
goalDefinitionId query array[string] false N/A Filters the response to only goals that are tied to 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. -
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 Goals
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden 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.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.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.healtheintent.com/longitudinal-plan/v1/goals/11e8902c9e2908c69718f13503066bee/progress-history?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.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. 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

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.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.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.healtheintent.com/longitudinal-plan/v1/goals/11e8902c9e2908c69718f13503066bee/status-history?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.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 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.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.healtheintent.com/longitudinal-plan/v1/goals/11e8591a4d5e569c8f673f9b3f4603ec \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "11e8591a4d5e569c8f673f9b3f4603ec",
  "consumer": {
    "id": "d8454f2a-665c-49d4-87db-8c167feae10e"
  },
  "description": "Pain maintained at or below acceptable pain rating",
  "version": 1,
  "startDate": "2017-12-04",
  "dueDate": "2017-12-20",
  "status": "IN_PROGRESS",
  "statusReason": "Pain maintenance has been done",
  "progress": "PROGRESSING",
  "targets": [
    {
      "measureType": {
        "contextId": "6edf9160-1741-4538-97b1-cf0c2a557b16",
        "conceptAlias": "HYPERTENSION_CLIN_DIA"
      },
      "detail": {
        "range": {
          "high": "80",
          "low": "70"
        }
      }
    },
    {
      "measureType": {
        "contextId": "58c88d96-7ad0-4bfe-92d0-de52fca87642",
        "conceptAlias": "HYPERTENSION_CLIN_SYS"
      },
      "detail": {
        "range": {
          "high": "130",
          "low": "120"
        }
      }
    }
  ],
  "goalDefinition": {
    "id": "11e8902c5fe1e3238afa990c2154a1a3",
    "text": "Cardiovascular Type 1"
  },
  "createdAt": "2018-07-25T17:03:14.120Z",
  "updatedAt": "2018-07-25T17:03:14.120Z",
  "createdBy": {
    "type": "PERSONNEL",
    "reference": {
      "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
    }
  },
  "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"
  },
  "priority": 1,
  "shortTermGoals": [
    {
      "id": "22e8902c79c4ee348fe5cf0da3dac656"
    }
  ],
  "longTermGoals": [
    {
      "id": "11e8902c79c4ee348fe5cf0da3dac545"
    }
  ],
  "healthConcerns": [
    {
      "id": "2f978977-4c67-448a-883b-5bbe8ca47bbd"
    }
  ],
  "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"
        }
      }
    }
  ]
}

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.

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.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"}],"targets":[{"measureType":{"contextId":"fd597b7c-690f-4158-93d5-bf8030e653f3","conceptAlias":"SCREENING_FOR_FUTURE_FALLS_RISK"},"detail":{"type":"BOOLEAN","boolean":{"value":"TRUE"}}}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.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"}],"targets":[{"measureType":{"contextId":"fd597b7c-690f-4158-93d5-bf8030e653f3","conceptAlias":"SCREENING_FOR_FUTURE_FALLS_RISK"},"detail":{"type":"BOOLEAN","boolean":{"value":"TRUE"}}}]}

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": [
    {
      "measureType": {
        "contextId": "fd597b7c-690f-4158-93d5-bf8030e653f3",
        "conceptAlias": "125_DIHYDROXY_VITAMIN_D"
      },
      "detail": {
        "type": "NUMERIC",
        "numeric": {
          "value": 5000,
          "operator": "<="
        }
      }
    }
  ],
  "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.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.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": [
        {
          "measureType": {
            "contextId": "fd597b7c-690f-4158-93d5-bf8030e653f3",
            "conceptAlias": "125_DIHYDROXY_VITAMIN_D"
          },
          "detail": {
            "type": "NUMERIC",
            "numeric": {
              "value": 5000,
              "operator": "<="
            }
          }
        }
      ],
      "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.healtheintent.com/longitudinal-plan/v1/activity-definitions?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.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. -
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.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":[{"measureType":{"contextId":"fd597b7c-690f-4158-93d5-bf8030e653f3","conceptAlias":"SCREENING_FOR_FUTURE_FALLS_RISK"},"detail":{"type":"BOOLEAN","boolean":{"value":"TRUE"}}}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us.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":[{"measureType":{"contextId":"fd597b7c-690f-4158-93d5-bf8030e653f3","conceptAlias":"SCREENING_FOR_FUTURE_FALLS_RISK"},"detail":{"type":"BOOLEAN","boolean":{"value":"TRUE"}}}]}

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": [
    {
      "measureType": {
        "contextId": "fd597b7c-690f-4158-93d5-bf8030e653f3",
        "conceptAlias": "125_DIHYDROXY_VITAMIN_D"
      },
      "detail": {
        "type": "NUMERIC",
        "numeric": {
          "value": 5000,
          "operator": "<="
        }
      }
    }
  ],
  "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.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.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": [
    {
      "measureType": {
        "contextId": "fd597b7c-690f-4158-93d5-bf8030e653f3",
        "conceptAlias": "125_DIHYDROXY_VITAMIN_D"
      },
      "detail": {
        "type": "NUMERIC",
        "numeric": {
          "value": 5000,
          "operator": "<="
        }
      }
    }
  ],
  "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.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"}],"targets":[{"measureType":{"contextId":"fd597b7c-690f-4158-93d5-bf8030e653f3","conceptAlias":"SCREENING_FOR_FUTURE_FALLS_RISK"},"detail":{"type":"BOOLEAN","boolean":{"value":"TRUE"}}}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.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"}],"targets":[{"measureType":{"contextId":"fd597b7c-690f-4158-93d5-bf8030e653f3","conceptAlias":"SCREENING_FOR_FUTURE_FALLS_RISK"},"detail":{"type":"BOOLEAN","boolean":{"value":"TRUE"}}}]}

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": [
    {
      "measureType": {
        "contextId": "fd597b7c-690f-4158-93d5-bf8030e653f3",
        "conceptAlias": "125_DIHYDROXY_VITAMIN_D"
      },
      "detail": {
        "type": "NUMERIC",
        "numeric": {
          "value": 5000,
          "operator": "<="
        }
      }
    }
  ]
}

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.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.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": [
        {
          "measureType": {
            "contextId": "fd597b7c-690f-4158-93d5-bf8030e653f3",
            "conceptAlias": "125_DIHYDROXY_VITAMIN_D"
          },
          "detail": {
            "type": "NUMERIC",
            "numeric": {
              "value": 5000,
              "operator": "<="
            }
          }
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/longitudinal-plan/v1/goal-definitions?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.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. -
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.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":[{"measureType":{"contextId":"fd597b7c-690f-4158-93d5-bf8030e653f3","conceptAlias":"SCREENING_FOR_FUTURE_FALLS_RISK"},"detail":{"type":"BOOLEAN","boolean":{"value":"TRUE"}}}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us.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":[{"measureType":{"contextId":"fd597b7c-690f-4158-93d5-bf8030e653f3","conceptAlias":"SCREENING_FOR_FUTURE_FALLS_RISK"},"detail":{"type":"BOOLEAN","boolean":{"value":"TRUE"}}}]}

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": [
    {
      "measureType": {
        "contextId": "fd597b7c-690f-4158-93d5-bf8030e653f3",
        "conceptAlias": "125_DIHYDROXY_VITAMIN_D"
      },
      "detail": {
        "type": "NUMERIC",
        "numeric": {
          "value": 5000,
          "operator": "<="
        }
      }
    }
  ]
}

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.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.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": [
    {
      "measureType": {
        "contextId": "fd597b7c-690f-4158-93d5-bf8030e653f3",
        "conceptAlias": "125_DIHYDROXY_VITAMIN_D"
      },
      "detail": {
        "type": "NUMERIC",
        "numeric": {
          "value": 5000,
          "operator": "<="
        }
      }
    }
  ]
}

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.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.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.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.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.healtheintent.com/longitudinal-plan/v1/categories?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.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.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.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.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.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.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.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.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.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.healtheintent.com/longitudinal-plan/v1/disciplines?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.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.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.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.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.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:

In order 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.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.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"
      },
      "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.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/strengths?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.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. -
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). -
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.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"}}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.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"}}}

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"
  },
  "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.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"}}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us.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"}}}

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"
  },
  "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.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.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"
  },
  "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.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.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.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.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.healtheintent.com/longitudinal-plan/v1/strength-definitions?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.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. -
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.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.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.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.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.

Schema Definitions

Strengths

Name Type Required Description Accepted Values
items [Strength] true An array containing the current page of results. -
totalResults integer(int32) false The total number of results for the specified parameters. -
firstLink string true The first page of results. -
lastLink string false The last page of results. -
prevLink string false The previous page of results. -
nextLink string false The next page of results. -

Strength

Name Type Required Description Accepted Values
id string true The ID of the strength. -
consumer Reference true The ID of the HealtheIntent consumer. See Consumer API for more information. -
description string true The description of the strength. -
startDate string true The date when the strength was first reported as present. The expected format is ISO 8601 YYYY-MM-DD. -
endDate string false The date when the strength was no longer reported as present. The expected format is ISO 8601 YYYY-MM-DD. -
status string true An enumerated list that describes the current status of the strength. When the strength is first created, the status is defaulted to DOCUMENTED. The following statuses are possible:
- DOCUMENTED: The strength is appropriately documented for the individual who is the focus of the strength.
- IN_ERROR: The strength was incorrectly documented.
DOCUMENTED, IN_ERROR
performedBy Individual false The individual responsible for initially establishing or expressing the strength. This may not be the same person who actually documents the strength in the system. An individual may express a strength to another party who actually documents the strength. -
strengthDefinition StrengthDefinitionReference true The strength definition associated with the strength. -
version integer(int32) true The current version of the strength. The version is also returned back as ETag on single GET, POST and PUT endpoints. The version value needs to be sent as If-Match header value for updating the resource. -
createdBy StrengthActor true A representation of the individual who entered the strength into the system. -
createdAt string true The date and time when the strength 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 strength is first created. -
updatedBy StrengthActor true A representation of the individual who modified the strength in the system. -
updatedAt string true The date and time when the strength 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 strength is modified. When the strength is first created, the value in ‘updatedAt’ is set by the service to match the value in the ‘createdAt’ field. -

Reference

Name Type Required Description Accepted Values
id string true The ID of the referenced entity. -

Individual

Name Type Required Description Accepted Values
type string true An enumerated list that describes the role the individual plays in relation to the entity. Currently, the following types are possible:
- SUBJECT: The focus of the entity
- PERSONNEL: A medical professional in the tenant organization
- RELATED_PERSON: A person related to the focus of the entity
PERSONNEL, SUBJECT, RELATED_PERSON
display string false A textual description of the individual being defined -
reference Reference false A reference to additional details about an individual who performed some action on the entity. Currently, only personnel and consumers can be directly referenced. See Consumer API and Personnel API for more information. -

StrengthDefinitionReference

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

StrengthActor

Name Type Required Description Accepted Values
type string true An enumerated list that describes the role the individual plays in relation to the entity. The following types are possible:
- SYSTEM: SYSTEM is used to identify a non-living entity that is interacting with the plan resources. This could occur when data is migrated to the longitudinal plan from another source or if a plan item is created or updated by an algorithm. When the type is SYSTEM, display is required.
- PERSONNEL: The individual is a medical professional who is part of the tenant’s enterprise. When this type is used, a reference to the professional’s entry in the personnel service is provided. When the type is PERSONNEL, id is required.
- SUBJECT: The individual is the focus of the strength.
PERSONNEL, SUBJECT, SYSTEM
reference Reference false A reference to the individual. -
display string false A textual display that describes the referenced entity. -

Error

Name Type Required Description Accepted Values
code integer(int32) true The HTTP response status code that represents the error. -
message string true A human-readable description of the error. -
errorDetails [ErrorDetail] false A list of additional error details. -

ErrorDetail

Name Type Required Description Accepted Values
domain string false A subsystem or context where an error occurred. -
reason string false A codified value that represents the specific error that caused the current error status. -
message string false A human-readable description of an error. -
locationType string false The location or type of the field that caused an error. query, header, path, formData, body
location string false The name of the field that caused an error. -

postConsumersConsumeridStrengths

Name Type Required Description Accepted Values
endDate string false The date when the strength was no longer reported as present. The expected format is ISO 8601 YYYY-MM-DD. -
description string true The description of the strength. -
startDate string true The date when the strength was first reported as present. The expected format is ISO 8601 YYYY-MM-DD. -
performedBy object false The individual responsible for initially establishing or expressing the strength. This may not be the same person who actually documents the strength in the system. An individual may express a strength to another party who actually documents the strength. -
» type string false An enumerated list that describes the role the individual plays in relation to the entity. Currently, the following types are possible:
- SUBJECT: The focus of the entity
- PERSONNEL: A medical professional in the tenant organization
- RELATED_PERSON: A person related to the focus of the entity
PERSONNEL, SUBJECT, RELATED_PERSON
» display string false A textual description of the individual being defined -
» reference object false A reference to the individual. If reference is provided, the type must be PERSONNEL. -
»» id string true The ID of the referenced entity. -
strengthDefinition object true The strength definition associated with the strength. -
» id string true The ID of the strength definition. -
createdBy object true A representation of the individual who entered the strength into the system. -
» type string false An enumerated list that describes the role the individual plays in relation to the entity. The following types are possible:
- SYSTEM: SYSTEM is used to identify a non-living entity that is interacting with the plan resources. This could occur when data is migrated to the longitudinal plan from another source or if a plan item is created or updated by an algorithm. When the type is SYSTEM, display is required.
- PERSONNEL: The individual is a medical professional who is part of the tenant’s enterprise. When this type is used, a reference to the professional’s entry in the personnel service is provided. When the type is PERSONNEL, id is required.
- SUBJECT: The individual is the focus of the strength.
PERSONNEL, SUBJECT, SYSTEM
» display string false A textual display that describes the referenced entity. -
» reference object false The individual who created the strength in the system. -
»» id string true The ID of the referenced entity. -

Goals

Name Type Required Description Accepted Values
items [Goal] true An array containing the current page of results. -
totalResults integer(int32) false The total number of results for the specified parameters. -
firstLink string true The first page of results. -
lastLink string false The last page of results. -
prevLink string false The previous page of results. -
nextLink string false The next page of results. -

Goal

Name Type Required Description Accepted Values
id string true The ID of the goal. -
consumer Reference true The consumer with which the goal is associated -
description string true A short description of the goal. The value in this field likely is personalized to the individual when the goal originates from a goal definition template. -
version integer(int32) true The current version of the goal. The version is also returned back as ETag on single GET, POST and PUT endpoints. The version value needs to be sent as If-Match header value for updating the resource. -
startDate string false The ISO 8601 date when the individual will begin making progress on the goal. This date may be different then when the goal was actually created in the system. This supports situations in which a goal is expressed but will not be acted on until a later date. -
dueDate string false The ISO 8601 date when the goal should be completed. -
status string true Indicates the current state of the goal. Currently, the following statuses are possible
- PLANNED: Indicates that the goal has been planned but is not yet being pursued.
- IN_PROGRESS: Indicates that the goal is being pursued and is ongoing.
- CANCELLED: Indicates that the goal will no longer be pursued.
- IN_ERROR: Indicates that the goal was mistakenly identified.
- PROPOSED: Indicates that the goal has been proposed.
- ACCEPTED: Indicates that the goal has been accepted or acknowledged.
- REJECTED: Indicates that the goal has been rejected.
- SUSPENDED: Indicates that the goal is on-hold.
- COMPLETED: Indicates that the goal is in a final state of completion.
PLANNED, IN_PROGRESS, CANCELLED, IN_ERROR, PROPOSED, ACCEPTED, REJECTED, SUSPENDED, COMPLETED
statusReason string false A textual representation of the reason the goal is in its current status. -
progress string false Indicates an assessment of the patient’s progress toward a goal. Currently, the following progresses are possible:
- AT_TARGET: Indicates that the patient is currently meeting the goal and will continue to work toward maintaining it.
- PROGRESSING: Indicates that the patient is progressing toward the goal or is doing better than they were previously.
- REGRESSING: Indicates that the patient is doing worse than they were previously.
- ACHIEVED: Indicates that the patient met the goal.
- NOT_ACHIEVED: Indicates that the patient did not meet the goal.
PROGRESSING, REGRESSING, AT_TARGET, ACHIEVED, NOT_ACHIEVED
targets [Target] 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. -
goalDefinition GoalDefinitionReference false The goal definition that was referenced when the goal was first created. This field is immutable and can be set only when the goal is initially created. -
createdAt string true The ISO 8601 date time when the goal was initially entered into the system. Precision is in the millisecond YYYY-MM-DDTHH:mm:ss.sssZ format, for example, 2018-02-13T20:41:18.181Z. The time represented by this field is set automatically when the goal is first created. Therefore, the field does not need to be set explicitly. -
updatedAt string true The ISO 8601 date time when the goal was last modified. Precision is in the millisecond YYYY-MM-DDTHH:mm:ss.sssZ format, for example, 2018-02-13T20:41:18.181Z. The time represented by this field is set automatically every time the goal is modified. Therefore, the field does not need to be set explicitly. When the goal is first created, the updatedAt value is set by the service and matches the createdAt field. -
createdBy Actor true A representation of the individual who entered the goal into the system. -
updatedBy Actor true A representation of the individual who last modified the goal in the system. When the goal is first created, the value in ‘updatedBy’ is set by the service and matches the ‘createdBy’ field. -
expressedBy Individual false The individual responsible for initially establishing or expressing the goal. This may not be the same person who actually enters the goal in the system. An individual may express a goal to another party who actually creates it. -
owners [Individual] false A list of the people who have taken ownership of the goal. The owner of the goal could be different than the person for whom the goal is created. For example, a young child may have a goal to regularly take medication, but the child’s parent may ultimately own be the owner of the goal if the child is too young to take medication on their own. -
recentNotes [Note] false A list of recently created active notes for a goal. The notes are sorted by created date and time in descending order. A maximum of two recently created active notes are retrieved. -
categories [CategoryReference] false A list of categories. -
disciplines [DisciplineReference] false A list of disciplines. -
sourceIdentifier SourceIdentifier false The source ID that uniquely identifies an entity in a HealtheIntent data partition. Source IDs are only useful n the context of the source they are collected from, for example, in interactions between the source and HealtheIntent. -
priority integer(int32) false A numeric value defining the importance relative to other goals. A lower number implies a higher importance. If two goals have the same priority, they are of equivalent importance. -
shortTermGoals [Reference] false A list of short-term goals related to the requested goal. If the requested goal is a short-term goal, this list is an empty collection. -
longTermGoals [Reference] false A list of long-term goals related to the requested goal. If the requested goal is a long-term goal, this list is an empty collection. -
healthConcerns [Reference] false A list of health concerns related to the goal. -
relatedActivitiesSummary RelatedActivitiesSummary false A summary of the activities related to the current goal. The summary includes all related activities, their statuses, and the number of activities in each status. This attribute is present only if the current goal has related activities. -
statusHistory [GoalStatusHistory] true A list of statuses that have been applied to the goal. The statuses are sorted by start date and time in descending order. A maximum of two statuses are retrieved. -
progressHistory [ProgressHistory] false A list of progresses that have been applied to the goal. The progresses are sorted by start date and time in descending order. A maximum of two progresses are retrieved. -

Target

Name Type Required Description Accepted Values
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 TargetDetail 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. -
conceptAlias string true The alias of the concept in the context for the measure type. -

TargetDetail

Name Type Required Description Accepted Values
boolean TargetBoolean false Indicates that the fulfillment of the goal or activity can be measured by the presence of the Boolean value. -
numeric TargetNumeric false Indicates that the goal or activity can be achieved based on the numeric value. -
range TargetRange 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

TargetNumeric

Name Type Required Description Accepted Values
value number(double) true The numeric value of the measure type, which can include a decimal. -
operator string true The operator that indicates how the measure type value can be evaluated. >, <, >=, <=, =

TargetRange

Name Type Required Description Accepted Values
high number(double) true The inclusive upper boundary of the range, which can include a decimal. -
low number(double) true The inclusive lower boundary of the range, which can include a decimal. -

GoalDefinitionReference

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

Actor

Name Type Required Description Accepted Values
type string true An enumerated list that describes the role the individual plays in relation to the entity. Currently, it could be an application or algorithm (SYSTEM) or a professional in the tenant’s organization (PERSONNEL). See the following definitions:
- SYSTEM: - SYSTEM is used to identify a non-living entity that is interacting with the plan resources. This could occur when data is migrated to the longitudinal plan from another source or if a plan item is created or updated by an algorithm. When the type is SYSTEM, display is required.
- PERSONNEL: The individual is a medical professional who is part of the tenant’s enterprise. When this type is used, a reference to the professional’s entry in the personnel service is provided. When the type is PERSONNEL, id is required.
PERSONNEL, SYSTEM
reference Reference false A reference to the individual. -
display string false A textual display that describes the referenced entity. -

Note

Name Type Required Description Accepted Values
text string true The content of the note. -
id string true The ID of the note. -
version integer(int32) true The current version of the note. The version is also returned back as ETag on single GET, POST and PUT endpoints. The version value needs to be sent as If-Match header value for updating the resource. -
status string true The status of the note. ACTIVE, IN_ERROR
createdBy Actor true A representation of the individual who entered the note into the system. -
createdAt string true The ISO 8601 date time when the note was initially entered into the system. Precision is in the millisecond YYYY-MM-DDTHH:mm:ss.sssZ format, for example, 2018-02-13T20:41:18.181Z. The time represented by this field is set automatically when the note is first created. Therefore, the field does not need to be set explicitly. -
updatedBy Actor true A representation of the individual who last modified the note in the system. When the note is first created, the value in ‘updatedBy’ is set by the service and matches the ‘createdBy’ field. -
updatedAt string true The ISO 8601 date time when the note was last modified. Precision is in the millisecond YYYY-MM-DDTHH:mm:ss.sssZ format, for example, 2018-02-13T20:41:18.181Z. The time represented by this field is set automatically every time the activity is modified. Therefore, the field does not need to be set explicitly. When the activity is first created, the value of ‘updatedAt’ is set by the service and matches the value in the ‘createdAt’ field. -

CategoryReference

Name Type Required Description Accepted Values
id string true The ID of the category. -
text string false The textual description of the category. -

DisciplineReference

Name Type Required Description Accepted Values
id string true The ID of the discipline. -
text string false The textual description of the discipline. -

SourceIdentifier

Name Type Required Description Accepted Values
id string true The ID of the entity in the source system. -
dataPartitionId string true The HealtheIntent partition ID of the data source. -

RelatedActivitiesSummary

Name Type Required Description Accepted Values
statuses [StatusMetric] true The number of related activities that are in each status. -
totalCount integer(int32) true The total number of related activities. -

StatusMetric

Name Type Required Description Accepted Values
status string true A status on the list of results. -
count integer(int32) true The total number of items in the status. -

GoalStatusHistory

Name Type Required Description Accepted Values
status string true The status of the goal. The following statuses are possible:
- PLANNED: Indicates that the goal is planned but is not yet being pursued.
- IN_PROGRESS: Indicates that the goal is being pursued and is ongoing.
- CANCELLED: Indicates that the goal will no longer be pursued.
- IN_ERROR: Indicates that the goal was mistakenly identified.
- PROPOSED: Indicates that the goal is proposed.
- ACCEPTED: Indicates that the goal is accepted or acknowledged.
- REJECTED: Indicates that the goal is rejected.
- SUSPENDED: Indicates that the goal is on hold.
- COMPLETED: Indicates that the goal is in a final state of completion.
PLANNED, IN_PROGRESS, CANCELLED, IN_ERROR, PROPOSED, ACCEPTED, REJECTED, SUSPENDED, COMPLETED
startAt string true The date and time the status was applied to the goal, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. -
endAt string false The date and time the status was removed from the goal, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. -
updatedBy Actor true The individual who modified the status of the goal. -

ProgressHistory

Name Type Required Description Accepted Values
progress string false The progress toward the goal. The following progresses are possible:
- AT_TARGET: Indicates that the patient is meeting the goal and is working toward maintaining it.
- PROGRESSING: Indicates that the patient is progressing toward the goal or is doing better than before.
- REGRESSING: Indicates that the patient is doing worse than before.
- ACHIEVED: Indicates that the patient met the goal.
- NOT_ACHIEVED: Indicates that the patient did not meet the goal.
PROGRESSING, REGRESSING, AT_TARGET, ACHIEVED, NOT_ACHIEVED
startAt string true The date and time the progress was applied to the goal, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. -
endAt string false The date and time the progress was removed from the goal, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. -
updatedBy Actor true The individual who modified the progress toward the goal. -

HealthConcernReferences

Name Type Required Description Accepted Values
items [HealthConcernReference] true An array containing the current page of results. -
totalResults integer(int32) false The total number of results for the specified parameters. -
firstLink string true The first page of results. -
lastLink string false The last page of results. -
prevLink string false The previous page of results. -
nextLink string false The next page of results. -

HealthConcernReference

Name Type Required Description Accepted Values
id string true The ID of the health concern. -

Activities

Name Type Required Description Accepted Values
items [Activity] true An array containing the current page of results. -
totalResults integer(int32) false The total number of results for the specified parameters. -
firstLink string true The first page of results. -
lastLink string false The last page of results. -
prevLink string false The previous page of results. -
nextLink string false The next page of results. -

Activity

Name Type Required Description Accepted Values
id string true The ID of the activity. -
description string true The textual description of the activity. The value in this field likely is personalized to the individual when the activity originates from a activity definition template. -
version integer(int32) true The current version of the activity. The version is also returned back as ETag on single GET, POST and PUT endpoints. The version value needs to be sent as If-Match header value for updating the resource. -
startDate string false The date when activity began or is planned to begin. Formatted as a complete ISO 8601 date string. For example, an activity that starts on December 28th, 2018, is formatted as 2018-12-28. -
endDate string false The date when the activity was or is planned to be completed. Formatted as a complete ISO 8601 date string. For example, an activity that is completed December 28th, 2018, is formatted as “2018-12-28” -
status string true Indicates the current state of the activity. Currently, the following statuses are possible:
- NOT_STARTED: Indicates that the activity has yet to begin.
- IN_PROGRESS: Indicates that the activity has begun and is ongoing.
- COMPLETED: Indicates that the activity is in a final state of completion.
- CANCELLED: Indicates that the activity will no longer take place.
- SUSPENDED: Indicates that the activity is on-hold.
- SCHEDULED: Indicates that the activity has been scheduled but has not yet begun.
- PROPOSED: Indicates that the activity has been proposed.
- ACCEPTED: Indicates that the activity has been accepted or acknowledged.
- REJECTED: Indicates that the activity has been rejected.
- IN_ERROR: Indicates that the activity was mistakenly identified.
NOT_STARTED, IN_PROGRESS, COMPLETED, CANCELLED, SUSPENDED, SCHEDULED, PROPOSED, ACCEPTED, REJECTED, IN_ERROR
schedule Schedule false How frequently, for how long, and how many times an action should be performed. -
targets [Target] 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. -
recentNotes [Note] false A list of recently created active notes for an activity. The notes are sorted by created date and time in descending order. A maximum of two recently created active notes are retrieved. -
categories [CategoryReference] false A list of categories. -
disciplines [DisciplineReference] false A list of disciplines. -
statusReason string false A textual representation of the reason the activity is in its current status. -
activityDefinition ActivityDefinitionReference false The activity definition that was referenced when the activity was first created. This field is immutable and can be set only when the activity is initially created. -
createdBy ActivityActor true A representation of the individual who entered the activity into the system. -
createdAt string true The ISO 8601 date time when the activity was initially entered into the system. Precision is in the millisecond YYYY-MM-DDTHH:mm:ss.sssZ format, for example, 2018-02-13T20:41:18.181Z. The time represented by this field is set automatically when the activity is first created. Therefore, the field does not need to be set explicitly. -
updatedAt string true The date and time when the activity was updated, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. -
updatedBy ActivityActor true A representation of the individual who last modified the activity within the system. When the activity is first created, the value in updatedBy is set by the service and matches the “createdBy” field. -
performers [Individual] false The individuals who are expected to be involved in the activity. The following performers are possible: - SUBJECT: The subject of the activity - RELATED_PERSON: An individual related to the subject such as a parent or guardian - PERSONNEL: A medical professional in or outside the organization -
sourceIdentifier SourceIdentifier false The source ID identifies an entity that is unique within a HealtheIntent data partition. Source IDs are only useful in the context of the source from which they are collected, for example, in interactions between the source and HealtheIntent. -
healthConcerns [Reference] false A list of health concerns related to the activity. -
goals [Reference] false A list of goals related to the activity. -
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. -
statusHistory [ActivityStatusHistory] true A list of statuses that have been applied to the activity. The statuses are sorted by start date and time in descending order. A maximum of two statuses are retrieved. -

Schedule

Name Type Required Description Accepted Values
frequency string true The number of times to repeat the action in the specified period or period range. -
period string true The duration of time over which repetitions are to occur. -
periodUnit string true The unit of time for the period. S, MIN, H, D, WK, MO, A
duration string false How long the activity should last. If duration is provided, durationUnit must be provided. -
durationUnit string false The unit of time for the duration. If durationUnit is provided, duration must be provided. S, MIN, H, D, WK, MO, A

ActivityDefinitionReference

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

ActivityActor

Name Type Required Description Accepted Values
type string true An enumerated list that describes the role the individual plays in relation to the activity. Currently, the following types are possible:
- SUBJECT: The individual is the consumer associated with the activity. When this type is used, a reference to the consumer is provided. When the type is SUBJECT, id is not required.
- PERSONNEL: The individual is a medical professional who is part of the tenant’s enterprise. When this type is used, a reference to the professional’s entry in the personnel service is provided. When the type is PERSONNEL, id is required.
- SYSTEM: SYSTEM is used to identify a non-living entity that is interacting with the plan resources. This can occur when data is migrated to the longitudinal plan from another source or if a plan item is created or updated by an algorithm. When the type is SYSTEM, display is required.
PERSONNEL, SYSTEM, SUBJECT
display string false A textual display that describes the referenced entity. -
reference Reference false A reference to the activity actor. If reference is provided, the type must be PERSONNEL. -

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. -

ActivityStatusHistory

Name Type Required Description Accepted Values
status string true The status of the activity. The following statuses are possible:
- NOT_STARTED: Indicates that the activity has not yet begun.
- IN_PROGRESS: Indicates that the activity has begun and is ongoing.
- COMPLETED: Indicates that the activity is in a final state of completion.
- CANCELLED: Indicates that the activity will no longer occur.
- SUSPENDED: Indicates that the activity is on hold.
- SCHEDULED: Indicates that the activity is scheduled but has not yet begun.
- PROPOSED: Indicates that the activity is proposed.
- ACCEPTED: Indicates that the activity is accepted or acknowledged.
- REJECTED: Indicates that the activity is rejected.
- IN_ERROR: Indicates that the activity was mistakenly identified.
NOT_STARTED, IN_PROGRESS, COMPLETED, CANCELLED, SUSPENDED, SCHEDULED, PROPOSED, ACCEPTED, REJECTED, IN_ERROR
startAt string true The date and time when the status was applied to the activity, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. -
endAt string false The date and time when the status was removed from the activity, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. -
updatedBy ActivityActor true The individual who modified the status of the activity. -

putConsumersConsumeridGoalsGoalidNotes

Name Type Required Description Accepted Values
text string true The content of the note. -
updatedBy object true A representation of the individual who last modified the note in the system. When the note is first created, the value in ‘updatedBy’ is set by the service and matches the ‘createdBy’ field. -
» type string false An enumerated list that describes the role the individual plays in relation to the entity. Currently, it could be an application or algorithm (SYSTEM) or a professional in the tenant’s organization (PERSONNEL). See the following definitions:
- SYSTEM: - SYSTEM is used to identify a non-living entity that is interacting with the plan resources. This could occur when data is migrated to the longitudinal plan from another source or if a plan item is created or updated by an algorithm. When the type is SYSTEM, display is required.
- PERSONNEL: The individual is a medical professional who is part of the tenant’s enterprise. When this type is used, a reference to the professional’s entry in the personnel service is provided. When the type is PERSONNEL, id is required.
PERSONNEL, SYSTEM
» display string false A textual display that describes the referenced entity. -
» reference object false A reference to the individual. If reference is provided, the type must be PERSONNEL. -
»» id string true The ID of the referenced entity. -
status string true The status of the note. ACTIVE, IN_ERROR

postConsumersConsumeridGoalsGoalidNotes

Name Type Required Description Accepted Values
text string true The content of the note. -
createdBy object true A representation of the individual who entered the note into the system. -
» type string false An enumerated list that describes the role the individual plays in relation to the entity. Currently, it could be an application or algorithm (SYSTEM) or a professional in the tenant’s organization (PERSONNEL). See the following definitions:
- SYSTEM: - SYSTEM is used to identify a non-living entity that is interacting with the plan resources. This could occur when data is migrated to the longitudinal plan from another source or if a plan item is created or updated by an algorithm. When the type is SYSTEM, display is required.
- PERSONNEL: The individual is a medical professional who is part of the tenant’s enterprise. When this type is used, a reference to the professional’s entry in the personnel service is provided. When the type is PERSONNEL, id is required.
PERSONNEL, SYSTEM
» display string false A textual display that describes the referenced entity. -
» reference object false A reference to the individual. If reference is provided, the type must be PERSONNEL. -
»» id string true The ID of the referenced entity. -

Notes

Name Type Required Description Accepted Values
items [Note] true An array containing the current page of results. -
totalResults integer(int32) false The total number of results for the specified parameters. -
firstLink string true The first page of results. -
lastLink string false The last page of results. -
prevLink string false The previous page of results. -
nextLink string false The next page of results. -

putConsumersConsumeridGoals

Name Type Required Description Accepted Values
startDate string false The ISO 8601 date when the individual will begin making progress on the goal. This date may be different then when the goal was actually created in the system. This supports situations in which a goal is expressed but will not be acted on until a later date. -
dueDate string false The ISO 8601 date when the goal should be completed. -
statusReason string false A textual representation of the reason the goal is in its current status. -
progress string false Indicates an assessment of the patient’s progress toward a goal. Currently, the following progresses are possible:
- AT_TARGET: Indicates that the patient is currently meeting the goal and will continue to work toward maintaining it.
- PROGRESSING: Indicates that the patient is progressing toward the goal or is doing better than they were previously.
- REGRESSING: Indicates that the patient is doing worse than they were previously.
- ACHIEVED: Indicates that the patient met the goal.
- NOT_ACHIEVED: Indicates that the patient did not meet the goal.
PROGRESSING, REGRESSING, AT_TARGET, ACHIEVED, NOT_ACHIEVED
targets [object] 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. -
» measureType [object] true The type of parameter that is being tracked, for example, body weight, blood pressure, or hemoglobin A1c level. -
»» contextId string true The ID of the context for the measure type. -
»» conceptAlias string true The alias of the concept in the context for the measure type. -
» detail [object] 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. -
»» range [object] false Indicates that the goal or activity can be achieved based on the numeric boundaries of the range. -
»»» high number(double) true The inclusive upper boundary of the range, which can include a decimal. -
»»» low number(double) true The inclusive lower boundary of the range, which can include a decimal. -
»» numeric [object] false Indicates that the goal or activity can be achieved based on the numeric value. -
»»» value number(double) true The numeric value of the measure type, which can include a decimal. -
»»» operator string true The operator that indicates how the measure type value can be evaluated. -
»» boolean [object] false Indicates that the fulfillment of the goal or activity can be measured by the presence of the Boolean value. -
»»» value string true Indicates whether the measure type should be met. -
owners [object] false A list of the people who have taken ownership of the goal. The owner of the goal could be different than the person for whom the goal is created. For example, a young child may have a goal to regularly take medication, but the child’s parent may ultimately own be the owner of the goal if the child is too young to take medication on their own. -
» type string false An enumerated list that describes the role the individual plays in relation to the entity. Currently, the following types are possible:
- SUBJECT: The focus of the entity
- PERSONNEL: A medical professional in the tenant organization
- RELATED_PERSON: A person related to the focus of the entity
-
» display string false A textual description of the individual being defined -
» reference [object] false A reference to the individual. If reference is provided, the type must be PERSONNEL. -
»» id string true The ID of the referenced entity. -
priority integer(int32) false A numeric value defining the importance relative to other goals. A lower number implies a higher importance. If two goals have the same priority, they are of equivalent importance. -
description string true A short description of the goal. The value in this field likely is personalized to the individual when the goal originates from a goal definition template. -
status string true Indicates the current state of the goal. Currently, the following statuses are possible
- PLANNED: Indicates that the goal has been planned but is not yet being pursued.
- IN_PROGRESS: Indicates that the goal is being pursued and is ongoing.
- CANCELLED: Indicates that the goal will no longer be pursued.
- IN_ERROR: Indicates that the goal was mistakenly identified.
- PROPOSED: Indicates that the goal has been proposed.
- ACCEPTED: Indicates that the goal has been accepted or acknowledged.
- REJECTED: Indicates that the goal has been rejected.
- SUSPENDED: Indicates that the goal is on-hold.
- COMPLETED: Indicates that the goal is in a final state of completion.
PLANNED, IN_PROGRESS, CANCELLED, IN_ERROR, PROPOSED, ACCEPTED, REJECTED, SUSPENDED, COMPLETED
categories [object] false A list of category IDs. -
» id string true The ID of the category. -
disciplines [object] false A list of discipline IDs. -
» id string true The ID of the discipline. -
expressedBy object false The individual responsible for initially establishing or expressing the goal. This may not be the same person who actually enters the goal in the system. An individual may express a goal to another party who actually creates it. -
» type string false An enumerated list that describes the role the individual plays in relation to the entity. Currently, the following types are possible:
- SUBJECT: The focus of the entity
- PERSONNEL: A medical professional in the tenant organization
- RELATED_PERSON: A person related to the focus of the entity
PERSONNEL, SUBJECT, RELATED_PERSON
» display string false A textual description of the individual being defined -
» reference object false A reference to the individual. If reference is provided, the type must be PERSONNEL. -
»» id string true The ID of the referenced entity. -
updatedBy object true A representation of the individual who last modified the goal in the system. When the goal is first created, the value in ‘updatedBy’ is set by the service and matches the ‘createdBy’ field. -
» type string false An enumerated list that describes the role the individual plays in relation to the entity. Currently, it could be an application or algorithm (SYSTEM) or a professional in the tenant’s organization (PERSONNEL). See the following definitions:
- SYSTEM: - SYSTEM is used to identify a non-living entity that is interacting with the plan resources. This could occur when data is migrated to the longitudinal plan from another source or if a plan item is created or updated by an algorithm. When the type is SYSTEM, display is required.
- PERSONNEL: The individual is a medical professional who is part of the tenant’s enterprise. When this type is used, a reference to the professional’s entry in the personnel service is provided. When the type is PERSONNEL, id is required.
PERSONNEL, SYSTEM
» display string false A textual display that describes the referenced entity. -
» reference object false A reference to the individual. If reference is provided, the type must be PERSONNEL. -
»» id string true The ID of the referenced entity. -

postConsumersConsumeridGoals

Name Type Required Description Accepted Values
startDate string false The ISO 8601 date when the individual will begin making progress on the goal. This date may be different then when the goal was actually created in the system. This supports situations in which a goal is expressed but will not be acted on until a later date. -
dueDate string false The ISO 8601 date when the goal should be completed. -
statusReason string false A textual representation of the reason the goal is in its current status. -
progress string false Indicates an assessment of the patient’s progress toward a goal. Currently, the following progresses are possible:
- AT_TARGET: Indicates that the patient is currently meeting the goal and will continue to work toward maintaining it.
- PROGRESSING: Indicates that the patient is progressing toward the goal or is doing better than they were previously.
- REGRESSING: Indicates that the patient is doing worse than they were previously.
- ACHIEVED: Indicates that the patient met the goal.
- NOT_ACHIEVED: Indicates that the patient did not meet the goal.
PROGRESSING, REGRESSING, AT_TARGET, ACHIEVED, NOT_ACHIEVED
targets [object] 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. -
» measureType [object] true The type of parameter that is being tracked, for example, body weight, blood pressure, or hemoglobin A1c level. -
»» contextId string true The ID of the context for the measure type. -
»» conceptAlias string true The alias of the concept in the context for the measure type. -
» detail [object] 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. -
»» range [object] false Indicates that the goal or activity can be achieved based on the numeric boundaries of the range. -
»»» high number(double) true The inclusive upper boundary of the range, which can include a decimal. -
»»» low number(double) true The inclusive lower boundary of the range, which can include a decimal. -
»» numeric [object] false Indicates that the goal or activity can be achieved based on the numeric value. -
»»» value number(double) true The numeric value of the measure type, which can include a decimal. -
»»» operator string true The operator that indicates how the measure type value can be evaluated. -
»» boolean [object] false Indicates that the fulfillment of the goal or activity can be measured by the presence of the Boolean value. -
»»» value string true Indicates whether the measure type should be met. -
owners [object] false A list of the people who have taken ownership of the goal. The owner of the goal could be different than the person for whom the goal is created. For example, a young child may have a goal to regularly take medication, but the child’s parent may ultimately own be the owner of the goal if the child is too young to take medication on their own. -
» type string false An enumerated list that describes the role the individual plays in relation to the entity. Currently, the following types are possible:
- SUBJECT: The focus of the entity
- PERSONNEL: A medical professional in the tenant organization
- RELATED_PERSON: A person related to the focus of the entity
-
» display string false A textual description of the individual being defined -
» reference [object] false A reference to the individual. If reference is provided, the type must be PERSONNEL. -
»» id string true The ID of the referenced entity. -
priority integer(int32) false A numeric value defining the importance relative to other goals. A lower number implies a higher importance. If two goals have the same priority, they are of equivalent importance. -
description string true A short description of the goal. The value in this field likely is personalized to the individual when the goal originates from a goal definition template. -
status string true Indicates the current state of the goal. Currently, the following statuses are possible
- PLANNED: Indicates that the goal has been planned but is not yet being pursued.
- IN_PROGRESS: Indicates that the goal is being pursued and is ongoing.
- CANCELLED: Indicates that the goal will no longer be pursued.
- IN_ERROR: Indicates that the goal was mistakenly identified.
- PROPOSED: Indicates that the goal has been proposed.
- ACCEPTED: Indicates that the goal has been accepted or acknowledged.
- REJECTED: Indicates that the goal has been rejected.
- SUSPENDED: Indicates that the goal is on-hold.
- COMPLETED: Indicates that the goal is in a final state of completion.
PLANNED, IN_PROGRESS, CANCELLED, IN_ERROR, PROPOSED, ACCEPTED, REJECTED, SUSPENDED, COMPLETED
categories [object] false A list of category IDs. -
» id string true The ID of the category. -
disciplines [object] false A list of discipline IDs. -
» id string true The ID of the discipline. -
expressedBy object false The individual responsible for initially establishing or expressing the goal. This may not be the same person who actually enters the goal in the system. An individual may express a goal to another party who actually creates it. -
» type string false An enumerated list that describes the role the individual plays in relation to the entity. Currently, the following types are possible:
- SUBJECT: The focus of the entity
- PERSONNEL: A medical professional in the tenant organization
- RELATED_PERSON: A person related to the focus of the entity
PERSONNEL, SUBJECT, RELATED_PERSON
» display string false A textual description of the individual being defined -
» reference object false A reference to the individual. If reference is provided, the type must be PERSONNEL. -
»» id string true The ID of the referenced entity. -
createdBy object true A representation of the individual who entered the goal into the system. -
» type string false An enumerated list that describes the role the individual plays in relation to the entity. Currently, it could be an application or algorithm (SYSTEM) or a professional in the tenant’s organization (PERSONNEL). See the following definitions:
- SYSTEM: - SYSTEM is used to identify a non-living entity that is interacting with the plan resources. This could occur when data is migrated to the longitudinal plan from another source or if a plan item is created or updated by an algorithm. When the type is SYSTEM, display is required.
- PERSONNEL: The individual is a medical professional who is part of the tenant’s enterprise. When this type is used, a reference to the professional’s entry in the personnel service is provided. When the type is PERSONNEL, id is required.
PERSONNEL, SYSTEM
» display string false A textual display that describes the referenced entity. -
» reference object false A reference to the individual. If reference is provided, the type must be PERSONNEL. -
»» id string true The ID of the referenced entity. -
goalDefinition object false A reference to the goal definition. -
» id string true The ID of the goal definition. -
sourceIdentifier object false The source ID. -
» id string true The ID of the entity in the source system. -
» dataPartitionId string true The HealtheIntent partition ID of the data source. -

putConsumersConsumeridActivitiesActivityidNotes

Name Type Required Description Accepted Values
text string true The content of the note. -
updatedBy object true A representation of the individual who last modified the note in the system. When the note is first created, the value in ‘updatedBy’ is set by the service and matches the ‘createdBy’ field. -
» type string false An enumerated list that describes the role the individual plays in relation to the entity. Currently, it could be an application or algorithm (SYSTEM) or a professional in the tenant’s organization (PERSONNEL). See the following definitions:
- SYSTEM: - SYSTEM is used to identify a non-living entity that is interacting with the plan resources. This could occur when data is migrated to the longitudinal plan from another source or if a plan item is created or updated by an algorithm. When the type is SYSTEM, display is required.
- PERSONNEL: The individual is a medical professional who is part of the tenant’s enterprise. When this type is used, a reference to the professional’s entry in the personnel service is provided. When the type is PERSONNEL, id is required.
PERSONNEL, SYSTEM
» display string false A textual display that describes the referenced entity. -
» reference object false A reference to the individual. If reference is provided, the type must be PERSONNEL. -
»» id string true The ID of the referenced entity. -
status string true The status of the note. ACTIVE, IN_ERROR

postConsumersConsumeridActivitiesActivityidNotes

Name Type Required Description Accepted Values
text string true The content of the note. -
createdBy object true A representation of the individual who entered the note into the system. -
» type string false An enumerated list that describes the role the individual plays in relation to the entity. Currently, it could be an application or algorithm (SYSTEM) or a professional in the tenant’s organization (PERSONNEL). See the following definitions:
- SYSTEM: - SYSTEM is used to identify a non-living entity that is interacting with the plan resources. This could occur when data is migrated to the longitudinal plan from another source or if a plan item is created or updated by an algorithm. When the type is SYSTEM, display is required.
- PERSONNEL: The individual is a medical professional who is part of the tenant’s enterprise. When this type is used, a reference to the professional’s entry in the personnel service is provided. When the type is PERSONNEL, id is required.
PERSONNEL, SYSTEM
» display string false A textual display that describes the referenced entity. -
» reference object false A reference to the individual. If reference is provided, the type must be PERSONNEL. -
»» id string true The ID of the referenced entity. -

putConsumersConsumeridActivities

Name Type Required Description Accepted Values
startDate string false The date when activity began or is planned to begin. Formatted as a complete ISO 8601 date string. For example, an activity that starts on December 28th, 2018, is formatted as 2018-12-28. -
endDate string false The date when the activity was or is planned to be completed. Formatted as a complete ISO 8601 date string. For example, an activity that is completed December 28th, 2018, is formatted as “2018-12-28” -
targets [object] 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. -
» measureType [object] true The type of parameter that is being tracked, for example, body weight, blood pressure, or hemoglobin A1c level. -
»» contextId string true The ID of the context for the measure type. -
»» conceptAlias string true The alias of the concept in the context for the measure type. -
» detail [object] 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. -
»» range [object] false Indicates that the goal or activity can be achieved based on the numeric boundaries of the range. -
»»» high number(double) true The inclusive upper boundary of the range, which can include a decimal. -
»»» low number(double) true The inclusive lower boundary of the range, which can include a decimal. -
»» numeric [object] false Indicates that the goal or activity can be achieved based on the numeric value. -
»»» value number(double) true The numeric value of the measure type, which can include a decimal. -
»»» operator string true The operator that indicates how the measure type value can be evaluated. -
»» boolean [object] false Indicates that the fulfillment of the goal or activity can be measured by the presence of the Boolean value. -
»»» value string true Indicates whether the measure type should be met. -
statusReason string false A textual representation of the reason the activity is in its current status. -
performers [object] false The individuals who are expected to be involved in the activity. The following types of performers are possible:
- SUBJECT: The subject of the activity.
- RELATED_PERSON: An individual related to the subject such as a parent or guardian.
- PERSONNEL: A medical professional in or outside the organization.
-
» type string false An enumerated list that describes the role the individual plays in relation to the entity. Currently, the following types are possible:
- SUBJECT: The focus of the entity
- PERSONNEL: A medical professional in the tenant organization
- RELATED_PERSON: A person related to the focus of the entity
-
» display string false A textual description of the individual being defined -
» reference [object] false A reference to the individual. If reference is provided, the type must be PERSONNEL. -
»» id string true The ID of the referenced entity. -
supportingExternalReferences [object] false References to items that exist outside of HealtheIntent and would support the progression or completion of the activity. Note that an externalSupportingReference does not provide all the information required for a system that uses this API to locate and retrieve the item referenced. Due to this, systems that use an externalSupportingReference need prior knowledge and coordination with the system that contains the externalSupportingReference to understand how to retrieve the information about the item referenced. -
» system string true The namespace that contains the resource. -
» id string true The ID of the resource in the system namespace. -
supportingReferences [object] false References to items that exist in HealtheIntent and would support the progression or completion of the activity. -
» kind string true A description of the type of referenced resource. -
» id string true The ID of the resource in HealtheIntent. -
description string true The textual description of the activity. The value in this field likely is personalized to the individual when the activity originates from a activity definition template. -
status string true Indicates the current state of the activity. Currently, the following statuses are possible:
- NOT_STARTED: Indicates that the activity has yet to begin.
- IN_PROGRESS: Indicates that the activity has begun and is ongoing.
- COMPLETED: Indicates that the activity is in a final state of completion.
- CANCELLED: Indicates that the activity will no longer take place.
- SUSPENDED: Indicates that the activity is on-hold.
- SCHEDULED: Indicates that the activity has been scheduled but has not yet begun.
- PROPOSED: Indicates that the activity has been proposed.
- ACCEPTED: Indicates that the activity has been accepted or acknowledged.
- REJECTED: Indicates that the activity has been rejected.
- IN_ERROR: Indicates that the activity was mistakenly identified.
NOT_STARTED, IN_PROGRESS, COMPLETED, CANCELLED, SUSPENDED, SCHEDULED, PROPOSED, ACCEPTED, REJECTED, IN_ERROR
categories [object] false A list of category IDs. -
» id string true The ID of the category. -
disciplines [object] false A list of discipline IDs. -
» id string true The ID of the discipline. -
schedule object false How frequently, for how long, and how many times an action should be performed. -
» frequency integer(int32) true The number of times to repeat the action in the specified period. -
» period integer(int32) true The duration of time over which repetitions are to occur. -
» periodUnit string true The unit of time. The following values are possible:
- Second (S)
- Minute (MIN)
- Hour (H)
- Day (D)
- Week (WK)
- Month (MO)
- Year (A)
S, MIN, H, D, WK, MO, A
» duration integer(int32) false How long the activity should last. If this field is present, durationUnit must be provided. -
» durationUnit string false The unit of time. The following values are possible:
- Second (S)
- Minute (MIN)
- Hour (H)
- Day (D)
- Week (WK)
- Month (MO)
- Year (A)
S, MIN, H, D, WK, MO, A
updatedBy object true The individual who last modified the health concern in the system. When the health concern is first created, the updatedBy value is set by the service to match the createdBy field. -
» type string false An enumerated list that describes the role the individual plays in relation to the activity. Currently, the following types are possible:
- SUBJECT: The individual is the consumer associated with the activity. When this type is used, a reference to the consumer is provided. When the type is SUBJECT, id is not required.
- PERSONNEL: The individual is a medical professional who is part of the tenant’s enterprise. When this type is used, a reference to the professional’s entry in the personnel service is provided. When the type is PERSONNEL, id is required.
- SYSTEM: SYSTEM is used to identify a non-living entity that is interacting with the plan resources. This can occur when data is migrated to the longitudinal plan from another source or if a plan item is created or updated by an algorithm. When the type is SYSTEM, display is required.
PERSONNEL, SYSTEM, SUBJECT
» display string false A textual display that describes the referenced entity. -
» reference object false A reference to the individual. If reference is provided, the type must be PERSONNEL. -
»» id string true The ID of the referenced entity. -

postConsumersConsumeridActivities

Name Type Required Description Accepted Values
startDate string false The date when activity began or is planned to begin. Formatted as a complete ISO 8601 date string. For example, an activity that starts on December 28th, 2018, is formatted as 2018-12-28. -
endDate string false The date when the activity was or is planned to be completed. Formatted as a complete ISO 8601 date string. For example, an activity that is completed December 28th, 2018, is formatted as “2018-12-28” -
targets [object] 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. -
» measureType [object] true The type of parameter that is being tracked, for example, body weight, blood pressure, or hemoglobin A1c level. -
»» contextId string true The ID of the context for the measure type. -
»» conceptAlias string true The alias of the concept in the context for the measure type. -
» detail [object] 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. -
»» range [object] false Indicates that the goal or activity can be achieved based on the numeric boundaries of the range. -
»»» high number(double) true The inclusive upper boundary of the range, which can include a decimal. -
»»» low number(double) true The inclusive lower boundary of the range, which can include a decimal. -
»» numeric [object] false Indicates that the goal or activity can be achieved based on the numeric value. -
»»» value number(double) true The numeric value of the measure type, which can include a decimal. -
»»» operator string true The operator that indicates how the measure type value can be evaluated. -
»» boolean [object] false Indicates that the fulfillment of the goal or activity can be measured by the presence of the Boolean value. -
»»» value string true Indicates whether the measure type should be met. -
statusReason string false A textual representation of the reason the activity is in its current status. -
performers [object] false The individuals who are expected to be involved in the activity. The following types of performers are possible:
- SUBJECT: The subject of the activity.
- RELATED_PERSON: An individual related to the subject such as a parent or guardian.
- PERSONNEL: A medical professional in or outside the organization.
-
» type string false An enumerated list that describes the role the individual plays in relation to the entity. Currently, the following types are possible:
- SUBJECT: The focus of the entity
- PERSONNEL: A medical professional in the tenant organization
- RELATED_PERSON: A person related to the focus of the entity
-
» display string false A textual description of the individual being defined -
» reference [object] false A reference to the individual. If reference is provided, the type must be PERSONNEL. -
»» id string true The ID of the referenced entity. -
supportingExternalReferences [object] false References to items that exist outside of HealtheIntent and would support the progression or completion of the activity. Note that an externalSupportingReference does not provide all the information required for a system that uses this API to locate and retrieve the item referenced. Due to this, systems that use an externalSupportingReference need prior knowledge and coordination with the system that contains the externalSupportingReference to understand how to retrieve the information about the item referenced. -
» system string true The namespace that contains the resource. -
» id string true The ID of the resource in the system namespace. -
supportingReferences [object] false References to items that exist in HealtheIntent and would support the progression or completion of the activity. -
» kind string true A description of the type of referenced resource. -
» id string true The ID of the resource in HealtheIntent. -
description string true The textual description of the activity. The value in this field likely is personalized to the individual when the activity originates from a activity definition template. -
status string true Indicates the current state of the activity. Currently, the following statuses are possible:
- NOT_STARTED: Indicates that the activity has yet to begin.
- IN_PROGRESS: Indicates that the activity has begun and is ongoing.
- COMPLETED: Indicates that the activity is in a final state of completion.
- CANCELLED: Indicates that the activity will no longer take place.
- SUSPENDED: Indicates that the activity is on-hold.
- SCHEDULED: Indicates that the activity has been scheduled but has not yet begun.
- PROPOSED: Indicates that the activity has been proposed.
- ACCEPTED: Indicates that the activity has been accepted or acknowledged.
- REJECTED: Indicates that the activity has been rejected.
- IN_ERROR: Indicates that the activity was mistakenly identified.
NOT_STARTED, IN_PROGRESS, COMPLETED, CANCELLED, SUSPENDED, SCHEDULED, PROPOSED, ACCEPTED, REJECTED, IN_ERROR
categories [object] false A list of category IDs. -
» id string true The ID of the category. -
disciplines [object] false A list of discipline IDs. -
» id string true The ID of the discipline. -
schedule object false How frequently, for how long, and how many times an action should be performed. -
» frequency integer(int32) true The number of times to repeat the action in the specified period. -
» period integer(int32) true The duration of time over which repetitions are to occur. -
» periodUnit string true The unit of time. The following values are possible:
- Second (S)
- Minute (MIN)
- Hour (H)
- Day (D)
- Week (WK)
- Month (MO)
- Year (A)
S, MIN, H, D, WK, MO, A
» duration integer(int32) false How long the activity should last. If this field is present, durationUnit must be provided. -
» durationUnit string false The unit of time. The following values are possible:
- Second (S)
- Minute (MIN)
- Hour (H)
- Day (D)
- Week (WK)
- Month (MO)
- Year (A)
S, MIN, H, D, WK, MO, A
createdBy object true A representation of the individual who entered the activity into the system. -
» type string false An enumerated list that describes the role the individual plays in relation to the activity. Currently, the following types are possible:
- SUBJECT: The individual is the consumer associated with the activity. When this type is used, a reference to the consumer is provided. When the type is SUBJECT, id is not required.
- PERSONNEL: The individual is a medical professional who is part of the tenant’s enterprise. When this type is used, a reference to the professional’s entry in the personnel service is provided. When the type is PERSONNEL, id is required.
- SYSTEM: SYSTEM is used to identify a non-living entity that is interacting with the plan resources. This can occur when data is migrated to the longitudinal plan from another source or if a plan item is created or updated by an algorithm. When the type is SYSTEM, display is required.
PERSONNEL, SYSTEM, SUBJECT
» display string false A textual display that describes the referenced entity. -
» reference object false A reference to the individual. If reference is provided, the type must be PERSONNEL. -
»» id string true The ID of the referenced entity. -
activityDefinition object false A reference to the activity definition. -
» id string true The ID of the activity definition. -
sourceIdentifier object false The source ID. -
» id string true The ID of the entity in the source system. -
» dataPartitionId string true The HealtheIntent partition ID of the data source. -

postActivityDefinitions

Name Type Required Description Accepted Values
text string true The short textual description of the activity definition. -
description string false The detailed description of the activity definition. -
instantiatesUrl string false The URL pointing to an externally maintained activity definition. -
categories [object] false A list of category IDs. -
» id string true The ID of the category. -
disciplines [object] false A list of discipline IDs. -
» id string true The ID of the discipline. -
supportingExternalReferences [object] false References to items that exist outside of HealtheIntent and would support the progression or completion of the activity. Note that an externalSupportingReference does not provide all the information required for a system that uses this API to locate and retrieve the item referenced. Due to this, systems that use an externalSupportingReference need prior knowledge and coordination with the system that contains the externalSupportingReference to understand how to retrieve the information about the item referenced. -
» system string true The namespace that contains the resource. -
» id string true The ID of the resource in the system namespace. -
supportingReferences [object] false References to items that exist in HealtheIntent and would support the progression or completion of the activity. -
» kind string true A description of the type of referenced resource. -
» id string true The ID of the resource in HealtheIntent. -
coding [object] false A list of coding objects. -
» code string true The ID of the code. -
» system string true The ID of the coding system that gives meaning to the code. -
» display string false The human-readable representation of the code. -
targets [object] 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. -
» measureType [object] true The type of parameter that is being tracked, for example, body weight, blood pressure, or hemoglobin A1c level. -
»» contextId string true The ID of the context for the measure type. -
»» conceptAlias string true The alias of the concept in the context for the measure type. -
» detail [object] 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. -
»» type string true The type of detail. -
»» boolean [object] false Indicates that the fulfillment of the goal or activity can be measured by the presence of the Boolean value. -
»»» value string true Indicates whether the measure type should be met. -
»» numeric [object] false Indicates that the goal or activity can be achieved based on the numeric value. -
»»» operator string true The operator that indicates how the measure type value can be evaluated. -
»»» value number(double) false The numeric value of the measure type, which can include a decimal. -
»» range [object] false Indicates that the goal or activity can be achieved based on the numeric boundaries of the range. -
»»» high number(double) false The inclusive upper boundary of the range, which can include a decimal. -
»»» low number(double) false The inclusive lower boundary of the range, which can include a decimal. -

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
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. -

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. -

TargetNumericDefinition

Name Type Required Description Accepted Values
value number(double) false The numeric value of the measure type, which can include a decimal. -
operator string true The operator that indicates how the measure type value can be evaluated. -

TargetRangeDefinition

Name Type Required Description Accepted Values
high number(double) false The inclusive upper boundary of the range, which can include a decimal. -
low number(double) false The inclusive lower boundary of the range, which can include a decimal. -

ActivityDefinitions

Name Type Required Description Accepted Values
items [ActivityDefinition] true An array containing the current page of results. -
totalResults integer(int32) false The total number of results for the specified parameters. -
firstLink string true The first page of results. -
lastLink string false The last page of results. -
prevLink string false The previous page of results. -
nextLink string false The next page of results. -

putActivityDefinitions

Name Type Required Description Accepted Values
text string true The short textual description of the activity definition. -
description string false The detailed description of the activity definition. -
instantiatesUrl string false The URL pointing to an externally maintained activity definition. -
categories [object] false A list of category IDs. -
» id string true The ID of the category. -
disciplines [object] false A list of discipline IDs. -
» id string true The ID of the discipline. -
supportingExternalReferences [object] false References to items that exist outside of HealtheIntent and would support the progression or completion of the activity. Note that an externalSupportingReference does not provide all the information required for a system that uses this API to locate and retrieve the item referenced. Due to this, systems that use an externalSupportingReference need prior knowledge and coordination with the system that contains the externalSupportingReference to understand how to retrieve the information about the item referenced. -
» system string true The namespace that contains the resource. -
» id string true The ID of the resource in the system namespace. -
supportingReferences [object] false References to items that exist in HealtheIntent and would support the progression or completion of the activity. -
» kind string true A description of the type of referenced resource. -
» id string true The ID of the resource in HealtheIntent. -
coding [object] false A list of coding objects. -
» code string true The ID of the code. -
» system string true The ID of the coding system that gives meaning to the code. -
» display string false The human-readable representation of the code. -
status string true The status of the activity definition. ACTIVE, INACTIVE
targets [object] 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. -
» measureType [object] true The type of parameter that is being tracked, for example, body weight, blood pressure, or hemoglobin A1c level. -
»» contextId string true The ID of the context for the measure type. -
»» conceptAlias string true The alias of the concept in the context for the measure type. -
» detail [object] 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. -
»» type string true The type of detail. -
»» boolean [object] false Indicates that the fulfillment of the goal or activity can be measured by the presence of the Boolean value. -
»»» value string true Indicates whether the measure type should be met. -
»» numeric [object] false Indicates that the goal or activity can be achieved based on the numeric value. -
»»» operator string true The operator that indicates how the measure type value can be evaluated. -
»»» value number(double) false The numeric value of the measure type, which can include a decimal. -
»» range [object] false Indicates that the goal or activity can be achieved based on the numeric boundaries of the range. -
»»» high number(double) false The inclusive upper boundary of the range, which can include a decimal. -
»»» low number(double) false The inclusive lower boundary of the range, which can include a decimal. -

ActivityStatusHistories

Name Type Required Description Accepted Values
items [ActivityStatusHistory] true An array containing the current page of results. -
totalResults integer(int32) false The total number of results for the specified parameters. -
firstLink string true The first page of results. -
lastLink string false The last page of results. -
prevLink string false The previous page of results. -
nextLink string false The next page of results. -

postCategories

Name Type Required Description Accepted Values
text string true The short description of the category. -
status string true The current status of the category. ACTIVE, INACTIVE
coding [object] false A list of coding objects. -
» code string true The ID of the code. -
» system string true The ID of the coding system that gives meaning to the code. -
» display string false The human-readable representation of the code. -

Categories

Name Type Required Description Accepted Values
items [Category] true An array containing the current page of results. -
totalResults integer(int32) false The total number of results for the specified parameters. -
firstLink string true The first page of results. -
lastLink string false The last page of results. -
prevLink string false The previous page of results. -
nextLink string false The next page of results. -

putCategories

Name Type Required Description Accepted Values
text string true The short description of the category. -
status string true The current status of the category. ACTIVE, INACTIVE
coding [object] false A list of coding objects. -
» code string true The ID of the code. -
» system string true The ID of the coding system that gives meaning to the code. -
» display string false The human-readable representation of the code. -

postDisciplines

Name Type Required Description Accepted Values
text string true The short description of the discipline. -
status string true The current status of the discipline. ACTIVE, INACTIVE
coding [object] false A list of coding objects. -
» code string true The ID of the code. -
» system string true The ID of the coding system that gives meaning to the code. -
» display string false The human-readable representation of the code. -

Disciplines

Name Type Required Description Accepted Values
items [Discipline] true An array containing the current page of results. -
totalResults integer(int32) false The total number of results for the specified parameters. -
firstLink string true The first page of results. -
lastLink string false The last page of results. -
prevLink string false The previous page of results. -
nextLink string false The next page of results. -

putDisciplines

Name Type Required Description Accepted Values
text string true The short description of the discipline. -
status string true The current status of the discipline. ACTIVE, INACTIVE
coding [object] false A list of coding objects. -
» code string true The ID of the code. -
» system string true The ID of the coding system that gives meaning to the code. -
» display string false The human-readable representation of the code. -

ProgressHistories

Name Type Required Description Accepted Values
items [ProgressHistory] true An array containing the current page of results. -
totalResults integer(int32) false The total number of results for the specified parameters. -
firstLink string true The first page of results. -
lastLink string false The last page of results. -
prevLink string false The previous page of results. -
nextLink string false The next page of results. -

GoalStatusHistories

Name Type Required Description Accepted Values
items [GoalStatusHistory] true An array containing the current page of results. -
totalResults integer(int32) false The total number of results for the specified parameters. -
firstLink string true The first page of results. -
lastLink string false The last page of results. -
prevLink string false The previous page of results. -
nextLink string false The next page of results. -

postGoalDefinitions

Name Type Required Description Accepted Values
text string true The short textual description of the goal definition. -
categories [object] false A list of category IDs. -
» id string true The ID of the category. -
disciplines [object] false A list of discipline IDs. -
» id string true The ID of the discipline. -
coding [object] false A list of coding objects. -
» code string true The ID of the code. -
» system string true The ID of the coding system that gives meaning to the code. -
» display string false The human-readable representation of the code. -
targets [object] 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. -
» measureType [object] true The type of parameter that is being tracked, for example, body weight, blood pressure, or hemoglobin A1c level. -
»» contextId string true The ID of the context for the measure type. -
»» conceptAlias string true The alias of the concept in the context for the measure type. -
» detail [object] 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. -
»» type string true The type of detail. -
»» boolean [object] false Indicates that the fulfillment of the goal or activity can be measured by the presence of the Boolean value. -
»»» value string true Indicates whether the measure type should be met. -
»» numeric [object] false Indicates that the goal or activity can be achieved based on the numeric value. -
»»» operator string true The operator that indicates how the measure type value can be evaluated. -
»»» value number(double) false The numeric value of the measure type, which can include a decimal. -
»» range [object] false Indicates that the goal or activity can be achieved based on the numeric boundaries of the range. -
»»» high number(double) false The inclusive upper boundary of the range, which can include a decimal. -
»»» low number(double) false The inclusive lower boundary of the range, which can include a decimal. -

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. -

GoalDefinitions

Name Type Required Description Accepted Values
items [GoalDefinition] true An array containing the current page of results. -
totalResults integer(int32) false The total number of results for the specified parameters. -
firstLink string true The first page of results. -
lastLink string false The last page of results. -
prevLink string false The previous page of results. -
nextLink string false The next page of results. -

putGoalDefinitions

Name Type Required Description Accepted Values
text string true The short textual description of the goal definition. -
categories [object] false A list of category IDs. -
» id string true The ID of the category. -
disciplines [object] false A list of discipline IDs. -
» id string true The ID of the discipline. -
coding [object] false A list of coding objects. -
» code string true The ID of the code. -
» system string true The ID of the coding system that gives meaning to the code. -
» display string false The human-readable representation of the code. -
status string true The status of the goal definition. ACTIVE, INACTIVE
targets [object] 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. -
» measureType [object] true The type of parameter that is being tracked, for example, body weight, blood pressure, or hemoglobin A1c level. -
»» contextId string true The ID of the context for the measure type. -
»» conceptAlias string true The alias of the concept in the context for the measure type. -
» detail [object] 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. -
»» type string true The type of detail. -
»» boolean [object] false Indicates that the fulfillment of the goal or activity can be measured by the presence of the Boolean value. -
»»» value string true Indicates whether the measure type should be met. -
»» numeric [object] false Indicates that the goal or activity can be achieved based on the numeric value. -
»»» operator string true The operator that indicates how the measure type value can be evaluated. -
»»» value number(double) false The numeric value of the measure type, which can include a decimal. -
»» range [object] false Indicates that the goal or activity can be achieved based on the numeric boundaries of the range. -
»»» high number(double) false The inclusive upper boundary of the range, which can include a decimal. -
»»» low number(double) false The inclusive lower boundary of the range, which can include a decimal. -

ActivityDefinitionTemplate

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

postPlanTemplates

Name Type Required Description Accepted Values
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
healthConcernDefinitions [object] false The health concern definitions representing the health concerns that are contained in this plan template. -
» id string false The ID of the health concern definition. -
» goalDefinitions [object] false The goal definitions representing the goals that support this health concern in the context of this plan template. -
»» id string false The ID of the goal definition. -
»» activityDefinitions [object] false The activity definitions representing the activities that support this goal in the context health concern of this plan template. -
»»» id string false The ID of the activity definition. -
»» shortTermGoalDefinitions [object] false The short-term goal definitions representing the short-term goals that support the long-term goal in the context of this plan template. -
»»» id string false The ID of the goal definition. -
»»» activityDefinitions object false The activity definitions representing the activities that support this goal in the context of this plan template. -
» activityDefinitions [object] false The activity definitions representing the activities that support this health concern in the context of this plan template. -
»» id string false The ID of the activity definition. -
goalDefinitions [object] false The goal definitions representing the goals that are contained in this plan template. -
» id string false The ID of the goal definition. -
» activityDefinitions [object] false The activity definitions representing the activities that support this goal in the context of this plan template. -
»» id string false The ID of the activity definition. -
» shortTermGoalDefinitions [object] false The short-term goal definitions representing the short-term goals that support the long-term goal in the context of this plan template. -
»» id string false The ID of the goal definition. -
»» activityDefinitions object false The activity definitions representing the activities that support this goal 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

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. -

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. -

PlanTemplates

Name Type Required Description Accepted Values
items [PlanTemplate] true An array containing the current page of results. -
totalResults integer(int32) false The total number of results for the specified parameters. -
firstLink string true The first page of results. -
lastLink string false The last page of results. -
prevLink string false The previous page of results. -
nextLink string false The next page of results. -

putPlanTemplates

Name Type Required Description Accepted Values
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
healthConcernDefinitions [object] false The health concern definitions representing the health concerns that are contained in this plan template. -
» id string false The ID of the health concern definition. -
» goalDefinitions [object] false The goal definitions representing the goals that support this health concern in the context of this plan template. -
»» id string false The ID of the goal definition. -
»» activityDefinitions [object] false The activity definitions representing the activities that support this goal in the context health concern of this plan template. -
»»» id string false The ID of the activity definition. -
»» shortTermGoalDefinitions [object] false The short-term goal definitions representing the short-term goals that support the long-term goal in the context of this plan template. -
»»» id string false The ID of the goal definition. -
»»» activityDefinitions object false The activity definitions representing the activities that support this goal in the context of this plan template. -
» activityDefinitions [object] false The activity definitions representing the activities that support this health concern in the context of this plan template. -
»» id string false The ID of the activity definition. -
goalDefinitions [object] false The goal definitions representing the goals that are contained in this plan template. -
» id string false The ID of the goal definition. -
» activityDefinitions [object] false The activity definitions representing the activities that support this goal in the context of this plan template. -
»» id string false The ID of the activity definition. -
» shortTermGoalDefinitions [object] false The short-term goal definitions representing the short-term goals that support the long-term goal in the context of this plan template. -
»» id string false The ID of the goal definition. -
»» activityDefinitions object false The activity definitions representing the activities that support this goal in the context of this plan template. -

putStrengths

Name Type Required Description Accepted Values
endDate string false The date when the strength was no longer reported as present. The expected format is ISO 8601 YYYY-MM-DD. -
description string true The description of the strength. -
startDate string true The date when the strength was first reported as present. The expected format is ISO 8601 YYYY-MM-DD. -
performedBy object false The individual responsible for initially establishing or expressing the strength. This may not be the same person who actually documents the strength in the system. An individual may express a strength to another party who actually documents the strength. -
» type string false An enumerated list that describes the role the individual plays in relation to the entity. Currently, the following types are possible:
- SUBJECT: The focus of the entity
- PERSONNEL: A medical professional in the tenant organization
- RELATED_PERSON: A person related to the focus of the entity
PERSONNEL, SUBJECT, RELATED_PERSON
» display string false A textual description of the individual being defined -
» reference object false A reference to the individual. If reference is provided, the type must be PERSONNEL. -
»» id string true The ID of the referenced entity. -
status string true An enumerated list that describes the current status of the strength. When the strength is first created, the status is defaulted to DOCUMENTED. The following statuses are possible: - DOCUMENTED: The strength is appropriately documented for the individual who is the focus of the strength. - IN_ERROR: The strength was incorrectly documented. DOCUMENTED, IN_ERROR
updatedBy object true A representation of the individual who last modified the strength in the system. When the strength is first created, the value in ‘updatedBy’ is set by the service and matches the ‘createdBy’ field. -
» type string false An enumerated list that describes the role the individual plays in relation to the entity. The following types are possible:
- SYSTEM: SYSTEM is used to identify a non-living entity that is interacting with the plan resources. This could occur when data is migrated to the longitudinal plan from another source or if a plan item is created or updated by an algorithm. When the type is SYSTEM, display is required.
- PERSONNEL: The individual is a medical professional who is part of the tenant’s enterprise. When this type is used, a reference to the professional’s entry in the personnel service is provided. When the type is PERSONNEL, id is required.
- SUBJECT: The individual is the focus of the strength.
PERSONNEL, SUBJECT, SYSTEM
» display string false A textual display that describes the referenced entity. -
» reference object false A reference to the individual. If reference is provided, the type must be PERSONNEL. -
»» id string true The ID of the referenced entity. -

postStrengthDefinitions

Name Type Required Description Accepted Values
text string true A textual description of the strength definition. -
status string true The current status of the strength definition. 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. -
status string true The current status of the strength definition. ACTIVE, INACTIVE
createdAt string true The date and time when the strength definition 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 strength definition is first created. -
updatedAt string true The date and time when the strength definition 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 strength definition is modified; therefore, the field does not need to be set explicitly. When the strength definition is first created, the value in ‘updatedAt’ is set by the service to match the value in the ‘createdAt’ field. -

StrengthDefinitions

Name Type Required Description Accepted Values
items [StrengthDefinition] true An array containing the current page of results. -
totalResults integer(int32) false The total number of results for the specified parameters. -
firstLink string true The first page of results. -
lastLink string false The last page of results. -
prevLink string false The previous page of results. -
nextLink string false The next page of results. -

putStrengthDefinitions

Name Type Required Description Accepted Values
text string true A textual description of the strength definition. -
status string true The current status of the strength definition. ACTIVE, INACTIVE