Longitudinal Plan API v1

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

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

Note: * If you specify an empty, null, or blank query parameter (for example, ?id=%20%20), a 400 (Bad Request) status code is returned. * When the API is in read-only mode, only GET requests are permitted.

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

Plan Templates

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

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

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

Plan template variation 1:
- Health Concern Definition List
  - Goal Definition List
    - Activity Definition List
    - Short-Term Goal Definition List
      - Activity Definition List
Plan template variation 2:
- Health Concern Definition List
  - Activity Definition List
Plan template variation 3:
- Goal Definition List
  - Activity Definition List
  - Short-Term Goal Definition List
    - Activity Definition List

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

Template 1:
- Health Concern: Coronary Artery Disease
  - Goal: Complications of CAD Avoided (13601000175105 : Complications of coronary heart disease avoided (finding))
    - Activity: Learn About Condition(s) and How to Avoid Complications (17221000175105 : Educated about how to avoid complications for conditions (situation))
    - Activity: Learn How Medications Improve Condition(s) (17281000175109 : Educated about how medication improves condition (situation))
    - Activity: Learn About Meaning of Lab Results (17241000175102 : Educated about meaning of laboratory test results (situation))
  - Goal: Improves Modifiable Risk Factors (13541000175106 : Modifiable risk factors for disorder improved (finding))
    - Activity: Learn Relevance of Preventative Health Care (16651000175100 : Educated about relevance of preventive health care (situation))
    - Activity: Stop Smoking (8517006 |Ex-smoker (finding))
    - Activity: Complete Smoking Cessation Class (17441000175101 : Smoking cessation class completed (finding))
Template 2:
- Goal: Utilize emergency department appropriately
  - Activity: Learn appropriate use of emergency department
Template 3:
- Health Concern: Tobacco Use
  - Activity: Take tobacco cessation workshop
  - Activity: Keep a tobacco diary
  - Activity: Exercise 150 minutes a week
Template 4:
- Health Concern: Nicotine Usage
  - Long-Term Goal: Reduce nicotine usage
    - Short-Term Goal: Identify benefits of nicotine use cessation
      - Activity: Educate patient about the benefits of smoking cessation and the cessation process
    - Short-Term Goal: Practice stress reduction techniques
      - Activity: Attend behavioral therapy sessions

Retrieve a Single Apply Plan Template Status


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/apply-templates/d443caca-b8a9-46c5-8db8-13bf2688f0dc', headers: headers)

print JSON.pretty_generate(result)


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

{
  "id": "70aefea8-0571-4542-8c92-2692be840388",
  "status": "IN_PROGRESS",
  "createdBy": {
    "type": "PERSONNEL",
    "reference": {
      "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
    }
  },
  "createdAt": "2018-07-25T17:03:14.120Z",
  "carePlan": {
    "description": "Diabetes Care Plan",
    "type": "VISIT",
    "status": "ACTIVE"
  },
  "report": {
    "items": [
      {
        "type": "HEALTH_CONCERN",
        "id": "11e8902c79c4ee348fe5cf0da3dac545",
        "definitionId": "11e8901b64b1ca0b9c300d1ad3125a44",
        "status": "SUCCESS"
      },
      {
        "type": "ACTIVITY",
        "id": "11e8902c79c4ee348fe5cf0da3dac545",
        "definitionId": "11e8901b64b1ca0b9c300d1ad3125a44",
        "status": "SUCCESS"
      },
      {
        "type": "GOAL",
        "id": "11e8902c79c4ee348fe5cf0da3dac545",
        "definitionId": "11e8901b64b1ca0b9c300d1ad3125a44",
        "status": "FAILED",
        "error": {
          "code": 400,
          "message": "Bad Request",
          "errorDetails": [
            {
              "message": "Status cannot be null.",
              "location": "template.healthConcernDefinitions[0][status]"
            }
          ]
        }
      },
      {
        "type": "RELATIONSHIP",
        "from": {
          "id": "11e8902c79c4ee348fe5cf0da3dac546",
          "definitionId": "11e8902c79c4ee348fe5cf0da3dac545",
          "type": "GOAL"
        },
        "to": {
          "id": "11e8902c79c4ee348fe5cf0da3dac547",
          "definitionId": "11e8901b64b1ca0b9c300d1ad3125a48",
          "type": "ACTIVITY"
        },
        "status": "FAILED",
        "error": {
          "code": 400,
          "message": "Bad Request",
          "errorDetails": [
            {
              "message": "Status cannot be null.",
              "location": "template.healthConcernDefinitions[0][status]"
            }
          ]
        }
      }
    ]
  }
}

GET /consumers/{consumerId}/apply-templates/{id}

Provides the status and report for a given job.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
consumerId	path	string	true	N/A	The ID of a Oracle Health Data Intelligence consumer. See Consumer API for more information.	-
id	path	string	true	N/A	The ID of the apply template job.	-

Response Statuses

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

Apply a Plan Template




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/{consumerId}/apply-templates', headers: headers, body: {"createdBy":{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}},"originatingSourceEncounter":{"id":"09920f12-006f-44za-019d-12kdk23094ee1","dataPartitionId":"4de3a1ab-5783-4e30-ba60-551ab1cf86fc"},"template":{"id":"11e8902c9e2908c69718f13503066bee","healthConcernDefinitions":[{"id":"11e8901b64b1ca0b9c300d1ad3125a48","status":"PROPOSED","goalDefinitions":[{"id":"11e8902c79c4ee348fe5cf0da3dac545","status":"PROPOSED","activityDefinitions":[{"id":"11e8902c5fe1e3238afa990c2154a1a1","status":"PROPOSED"}],"shortTermGoalDefinitions":[{"id":"11e8902c79c4ee348fe5cf0da3dac545","status":"PROPOSED","activityDefinitions":[{"id":"11e8902c5fe1e3238afa990c2154a1a2","status":"PROPOSED"}]}]}],"activityDefinitions":[{"id":"11e8902c5fe1e3238afa990c2154a1a3","status":"PROPOSED"}]}],"goalDefinitions":[{"id":"11e8902c79c4ee348fe5cf0da3dac545","status":"PROPOSED","activityDefinitions":[{"id":"11e8902c5fe1e3238afa990c2154a1a4","status":"PROPOSED"}],"shortTermGoalDefinitions":[{"id":"11e8902c79c4ee348fe5cf0da3dac545","activityDefinitions":[{"id":"11e8902c5fe1e3238afa990c2154a1a5","status":"PROPOSED"}]}]}]},"code":{"text":"Type 1 Diabetes Mellitus","codings":[{"code":"E10","system":"2.16.840.1.113883.6.90"},{"code":"190362004","system":"2.16.840.1.113883.6.96"}]},"text":"Type 1 Diabetes Mellitus","codings":[{"code":"E10","system":"2.16.840.1.113883.6.90"},{"code":"190362004","system":"2.16.840.1.113883.6.96"}],"carePlan":{"description":"Diabetes Care Plan","type":"VISIT","status":"ACTIVE"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/{consumerId}/apply-templates \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"createdBy":{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}},"originatingSourceEncounter":{"id":"09920f12-006f-44za-019d-12kdk23094ee1","dataPartitionId":"4de3a1ab-5783-4e30-ba60-551ab1cf86fc"},"template":{"id":"11e8902c9e2908c69718f13503066bee","healthConcernDefinitions":[{"id":"11e8901b64b1ca0b9c300d1ad3125a48","status":"PROPOSED","goalDefinitions":[{"id":"11e8902c79c4ee348fe5cf0da3dac545","status":"PROPOSED","activityDefinitions":[{"id":"11e8902c5fe1e3238afa990c2154a1a1","status":"PROPOSED"}],"shortTermGoalDefinitions":[{"id":"11e8902c79c4ee348fe5cf0da3dac545","status":"PROPOSED","activityDefinitions":[{"id":"11e8902c5fe1e3238afa990c2154a1a2","status":"PROPOSED"}]}]}],"activityDefinitions":[{"id":"11e8902c5fe1e3238afa990c2154a1a3","status":"PROPOSED"}]}],"goalDefinitions":[{"id":"11e8902c79c4ee348fe5cf0da3dac545","status":"PROPOSED","activityDefinitions":[{"id":"11e8902c5fe1e3238afa990c2154a1a4","status":"PROPOSED"}],"shortTermGoalDefinitions":[{"id":"11e8902c79c4ee348fe5cf0da3dac545","activityDefinitions":[{"id":"11e8902c5fe1e3238afa990c2154a1a5","status":"PROPOSED"}]}]}]},"code":{"text":"Type 1 Diabetes Mellitus","codings":[{"code":"E10","system":"2.16.840.1.113883.6.90"},{"code":"190362004","system":"2.16.840.1.113883.6.96"}]},"text":"Type 1 Diabetes Mellitus","codings":[{"code":"E10","system":"2.16.840.1.113883.6.90"},{"code":"190362004","system":"2.16.840.1.113883.6.96"}],"carePlan":{"description":"Diabetes Care Plan","type":"VISIT","status":"ACTIVE"}}

POST /consumers/{consumerId}/apply-templates

The apply template resource provides the ability to create plan items and relationships between them based on a full or partial plan template.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
202	Accepted	Apply a Plan Template	Job
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a Plan Template




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

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

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

print JSON.pretty_generate(result)




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

{
  "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


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

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

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

print JSON.pretty_generate(result)


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

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

GET /plan-templates

Retrieves a list of plan templates.

Parameters

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

Response Statuses

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

Update a Plan Template




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

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

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

print JSON.pretty_generate(result)




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

{
  "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


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

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

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

print JSON.pretty_generate(result)


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

{
  "id": "11e8902c9e2908c69718f13503066bee",
  "healthConcernDefinitions": [
    {
      "id": "11e8901b64b1ca0b9c300d1ad3125a48",
      "text": "Receive a flu shot",
      "status": "ACTIVE",
      "goalDefinitions": [
        {
          "id": "11e8902c79c4ee348fe5cf0da3dac545",
          "text": "Receive a flu shot",
          "status": "ACTIVE",
          "activityDefinitions": [
            {
              "id": "11e8902c5fe1e3238afa990c2154a1a3",
              "text": "Receive a flu shot",
              "status": "ACTIVE"
            }
          ],
          "shortTermGoalDefinitions": [
            {
              "id": "11e8902c79c4ee348fe5cf0da3dac545",
              "text": "Receive a flu shot",
              "status": "ACTIVE",
              "activityDefinitions": [
                {
                  "id": "11e8902c5fe1e3238afa990c2154a1a3",
                  "text": "Receive a flu shot",
                  "status": "ACTIVE"
                }
              ]
            }
          ]
        }
      ],
      "activityDefinitions": [
        {
          "id": "11e8902c5fe1e3238afa990c2154a1a3",
          "text": "Receive a flu shot",
          "status": "ACTIVE"
        }
      ]
    }
  ],
  "goalDefinitions": [
    {
      "id": "11e8902c79c4ee348fe5cf0da3dac545",
      "text": "Receive a flu shot",
      "status": "ACTIVE",
      "activityDefinitions": [
        {
          "id": "11e8902c5fe1e3238afa990c2154a1a3",
          "text": "Receive a flu shot",
          "status": "ACTIVE"
        }
      ],
      "shortTermGoalDefinitions": [
        {
          "id": "11e8902c79c4ee348fe5cf0da3dac545",
          "text": "Receive a flu shot",
          "status": "ACTIVE",
          "activityDefinitions": [
            {
              "id": "11e8902c5fe1e3238afa990c2154a1a3",
              "text": "Receive a flu shot",
              "status": "ACTIVE"
            }
          ]
        }
      ]
    }
  ],
  "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	PlanTemplateSingle
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Response Headers

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

Consumer Template Items

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

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


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

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

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

print JSON.pretty_generate(result)


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

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

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

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

Parameters

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

Response Statuses

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

Activities

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

Physical activity such as exercising two times per week
Nutritional management such as reducing the amount of carbohydrates in one’s diet
Educational resources that contribute to the person’s ability to learn.

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


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

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

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

print JSON.pretty_generate(result)


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

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

Removes a related health concern from an activity.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
consumerId	path	string	true	N/A	The ID of a Health Data Intelligence 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


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

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

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

print JSON.pretty_generate(result)


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

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

Relates a health concern to an activity.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
consumerId	path	string	true	N/A	The ID of a Health Data Intelligence 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


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

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

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

print JSON.pretty_generate(result)


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

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

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

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

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
consumerId	path	string	true	N/A	The ID of a Health Data Intelligence 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


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

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

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

print JSON.pretty_generate(result)


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

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

Removes a related goal from an activity.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
consumerId	path	string	true	N/A	The ID of a Health Data Intelligence 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


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

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

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

print JSON.pretty_generate(result)


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

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

Relates a goal to an activity.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
consumerId	path	string	true	N/A	The ID of a Health Data Intelligence 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


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

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

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

print JSON.pretty_generate(result)


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

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

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

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

Parameters

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

Response Statuses

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

Update an Activity Note




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

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

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

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/activities/11e8902c9e2908c69718f13503066bee/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","updatedSourceEncounter":{"id":"11e8901b64b1ca0b9c300d1ad3125a48","dataPartitionId":"4de3a1ab-5783-4e30-ba60-551ab1cf86fc"}}

{
  "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 Health Data Intelligence 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


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

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

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

print JSON.pretty_generate(result)


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

{
  "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 Health Data Intelligence 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




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

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

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

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/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"}},"originatingSourceEncounter":{"id":"11e8901b64b1ca0b9c300d1ad3125a48","dataPartitionId":"4de3a1ab-5783-4e30-ba60-551ab1cf86fc"}}

{
  "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 Health Data Intelligence 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


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

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

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

print JSON.pretty_generate(result)


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

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

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

Retrieves a list of activity notes.

Parameters

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

Response Statuses

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

Create an Activity Batch




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/activities/batch', headers: headers, body: {"activities":[{"id":"11ea9a1458b7dfce9be8bb0922bdb3c2","description":"Testing activity endpoint","status":"IN_ERROR","activityDefinitionId":"11ea9a145048c0bdb69e7f85eb7d02b7","createdBy":{"id":"test","type":"PERSONNEL"},"createdAt":"2020-05-19T21:04:36.669Z","healthConcerns":[{"id":"11e90eadb9840a26b54043a1ec525534"}],"activities":[{"id":"81d550d0-4569-49c5-bb08-28a8a5a34926"}]}],"status":"ACCEPTED","createdBy":{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}},"originatingSourceEncounter":{"id":"09920f12-006f-44za-019d-12kdk23094ee1","dataPartitionId":"4de3a1ab-5783-4e30-ba60-551ab1cf86fc"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/activities/batch \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"activities":[{"id":"11ea9a1458b7dfce9be8bb0922bdb3c2","description":"Testing activity endpoint","status":"IN_ERROR","activityDefinitionId":"11ea9a145048c0bdb69e7f85eb7d02b7","createdBy":{"id":"test","type":"PERSONNEL"},"createdAt":"2020-05-19T21:04:36.669Z","healthConcerns":[{"id":"11e90eadb9840a26b54043a1ec525534"}],"activities":[{"id":"81d550d0-4569-49c5-bb08-28a8a5a34926"}]}],"status":"ACCEPTED","createdBy":{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}},"originatingSourceEncounter":{"id":"09920f12-006f-44za-019d-12kdk23094ee1","dataPartitionId":"4de3a1ab-5783-4e30-ba60-551ab1cf86fc"}}

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

POST /consumers/{consumerId}/activities/batch

Creates a batch of activities. A maximum of 20 activities can be created.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
201	Created	Create an Activity Batch	ActivityBatchList
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
415	Unsupported Media Type	Unsupported Media Type	Error

Update an Activity




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

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

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

print JSON.pretty_generate(result)




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

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

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

Updates an activity.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
If-Match	header	string	true	N/A	The specific version of the activity resource to update.	-
consumerId	path	string	true	N/A	The ID of a Health Data Intelligence 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


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

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

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

print JSON.pretty_generate(result)


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

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

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

Retrieves a single activity.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
consumerId	path	string	true	N/A	The ID of a Health Data Intelligence 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




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

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

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

print JSON.pretty_generate(result)




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

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

POST /consumers/{consumerId}/activities

Creates a single activity.

Parameters

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

Response Statuses

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

Response Headers

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

Retrieve a List of Activities for a Consumer


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

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

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

print JSON.pretty_generate(result)


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

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

GET /consumers/{consumerId}/activities

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

Parameters

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

Response Statuses

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

Retrieve the Status History for an Activity


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

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

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

print JSON.pretty_generate(result)


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

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

GET /activities/{activityId}/status-history

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

Parameters

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

Response Statuses

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

Retrieve a List of Consumers with the Activities That Match the Specified Search Criteria


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

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

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

print JSON.pretty_generate(result)


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

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

GET /consumer-activities

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

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
activityCreatedAt	query	string	true	N/A	Filters the response to include consumers with activities that were created in the specific date and time range. 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-01T01:00Z, 2018-01-01T14:00Z) is all dates on or after January 1, 2017, 01:00, and before January 1, 2018, 14:00. Additionally, leaving the start or end blank indicates the range is unbounded; for example, (,2018-01-01T01:00Z) means any date before January 1, 2018, 01:00. All dates must be in ISO 8601 format YYYY-MM-DDThh:mmZ.	-
status	query	array[string]	false	N/A	Filters the response to only consumers that have activities in the specified status. The following statuses are possible: ACCEPTED, IN_PROGRESS, NOT_STARTED, SCHEDULED, PROPOSED, REJECTED, IN_ERROR, and SUSPENDED. To retrieve any unique combination of statuses, a query parameter must be provided for each status.	NOT_STARTED, IN_PROGRESS, COMPLETED, CANCELLED, SUSPENDED, SCHEDULED, PROPOSED, ACCEPTED, REJECTED, IN_ERROR
supportingReferenceKind	query	string	false	N/A	Filters the list of results to only consumers that have activities with the specified supporting reference.	-
supportingExternalReferenceSystem	query	string	false	N/A	Filters the list of results to only those with external supporting references in the specified external system. The value for this parameter must be encoded if the system includes special characters, for example, https%3A%2F%2Fapp.pluralsight.com%2Flibrary for https://app.pluralsight.com/library. If supportingExternalReferenceSystem is specified, supportingExternalReferenceId must also be specified.	-
supportingExternalReferenceId	query	string	false	N/A	Filters the list of results to only those with the specified external supporting reference. If supportingExternalReferenceId is specified, supportingExternalReferenceSystem must also be specified.	-
offset	query	integer(int32)	false	0	The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset.	-
limit	query	integer(int32)	false	20	The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	Retrieve a List of Consumers with the Activities That Match the Specified Search Criteria	ConsumerActivities
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error
500	Internal Server Error	Internal Server Error	Error

Goals

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

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

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

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

Long-Term Goal: Run a marathon.
- Short-Term Goal: Run a 5k.
- Short-Term Goal: Run a 10k.
- Short-Term Goal: Run a half-marathon.
Long-Term Goal: Reduce overall stress level.
- Short-Term Goal: Improve family relationships.
- Short-Term Goal: Expand support system.
- Short-Term Goal: Practice good nutrition.

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


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

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

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

print JSON.pretty_generate(result)


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

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

Removes a related short-term goal from a goal.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
consumerId	path	string	true	N/A	The ID of a Health Data Intelligence 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


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

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

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

print JSON.pretty_generate(result)


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

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

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

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
consumerId	path	string	true	N/A	The ID of a Health Data Intelligence 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


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

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

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

print JSON.pretty_generate(result)


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

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

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

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

Parameters

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

Response Statuses

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


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

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

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

print JSON.pretty_generate(result)


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

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

Removes a related health concern from a goal.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
consumerId	path	string	true	N/A	The ID of a Health Data Intelligence 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


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

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

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

print JSON.pretty_generate(result)


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

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

Relates a health concern to a goal.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
consumerId	path	string	true	N/A	The ID of a Health Data Intelligence 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


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

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

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

print JSON.pretty_generate(result)


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

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

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

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

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
consumerId	path	string	true	N/A	The ID of a Health Data Intelligence 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


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

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

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

print JSON.pretty_generate(result)


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

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

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

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

Parameters

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

Response Statuses

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

Update a Goal Note




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

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

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

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/goals/11e8591a4d5e569c8f673f9b3f4603ec/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","updatedSourceEncounter":{"id":"11e8901b64b1ca0b9c300d1ad3125a48","dataPartitionId":"4de3a1ab-5783-4e30-ba60-551ab1cf86fc"}}

{
  "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 Health Data Intelligence 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


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

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

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

print JSON.pretty_generate(result)


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

{
  "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 Health Data Intelligence 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




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

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

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

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/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"}},"originatingSourceEncounter":{"id":"11e8901b64b1ca0b9c300d1ad3125a48","dataPartitionId":"4de3a1ab-5783-4e30-ba60-551ab1cf86fc"}}

{
  "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 Health Data Intelligence 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


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

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

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

print JSON.pretty_generate(result)


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

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

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

Retrieves a list of goal notes.

Parameters

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

Response Statuses

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

Create a Goal Batch




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/goals/batch', headers: headers, body: {"goals":[{"goalDefinitionId":"11eaa5a40bd4b3c294d44bb7f9df9869","status":"IN_PROGRESS"}],"status":"ACCEPTED","createdBy":{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}},"originatingSourceEncounter":{"id":"09920f12-006f-44za-019d-12kdk23094ee1","dataPartitionId":"4de3a1ab-5783-4e30-ba60-551ab1cf86fc"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/goals/batch \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"goals":[{"goalDefinitionId":"11eaa5a40bd4b3c294d44bb7f9df9869","status":"IN_PROGRESS"}],"status":"ACCEPTED","createdBy":{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}},"originatingSourceEncounter":{"id":"09920f12-006f-44za-019d-12kdk23094ee1","dataPartitionId":"4de3a1ab-5783-4e30-ba60-551ab1cf86fc"}}

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

POST /consumers/{consumerId}/goals/batch

Creates a batch of goals. A maximum of 20 goals can be created.

Parameters

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

Response Statuses

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

Update a Goal




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

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

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

print JSON.pretty_generate(result)




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

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

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

Updates a single goal.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
If-Match	header	string	true	N/A	The specific version of the goal to update.	-
consumerId	path	string	true	N/A	The ID of a Health Data Intelligence 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




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

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

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

print JSON.pretty_generate(result)




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

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

POST /consumers/{consumerId}/goals

Creates a goal.

Parameters

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

Response Statuses

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

Response Headers

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

Retrieve a List of Goals for a Consumer


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

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

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

print JSON.pretty_generate(result)


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

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

GET /consumers/{consumerId}/goals

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

Parameters

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

Response Statuses

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

Retrieve a Single Goal


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

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

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

print JSON.pretty_generate(result)


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

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

GET /goals/{goalId}

Retrieves a single goal.

Parameters

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

Response Statuses

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

Response Headers

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

Retrieve a List of Goals for a Tenant


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

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

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

print JSON.pretty_generate(result)


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

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

GET /goals

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

Parameters

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

Response Statuses

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

Retrieve a List of Goal Barriers


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

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

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

print JSON.pretty_generate(result)


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

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

GET /goals/{goalId}/barriers

Retrieves a list of goal barriers.

Parameters

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

Response Statuses

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

Create a Goal Barrier




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/goals/11e8591a4d5e569c8f673f9b3f4603ec/barriers', headers: headers, body: {"barriers":[{"code":{"text":"Living in poverty","codings":[{"code":"11403006","system":"2.16.840.1.113883.6.96"}]},"status":"ACTIVE","concept":{"contextId":"37686A3F9C66452ABA66803ECC144344","conceptAlias":"LIVING_IN_POVERTY_CLIN"},"createdBy":{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}},"barrierDefinition":{"id":"11e8901b64b1ca0b9c300d1ad3125a48"}}],"code":{"text":"Living in poverty","codings":[{"code":"11403006","system":"2.16.840.1.113883.6.96"}]},"status":"ACTIVE","concept":{"contextId":"37686A3F9C66452ABA66803ECC144344","conceptAlias":"LIVING_IN_POVERTY_CLIN"},"createdBy":{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}},"barrierDefinition":{"id":"11e8901b64b1ca0b9c300d1ad3125a48"},"originatingSourceEncounter":{"id":"09920f12-006f-44za-019d-12kdk23094ee1","dataPartitionId":"4de3a1ab-5783-4e30-ba60-551ab1cf86fc"}}.to_json )

print JSON.pretty_generate(result)




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

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

POST /goals/{goalId}/barriers

Creates a goal barrier.

Parameters

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

Response Statuses

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

Update a Goal Barrier




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

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

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

print JSON.pretty_generate(result)




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

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

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

Updates a single goal barrier.

Parameters

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

Response Statuses

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

Response Headers

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

Retrieve a Single Goal Barrier


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

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

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

print JSON.pretty_generate(result)


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

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

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

Retrieves a single goal barrier.

Parameters

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

Response Statuses

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

Response Headers

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

Retrieve the Status History for a Goal


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

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

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

print JSON.pretty_generate(result)


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

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

GET /goals/{goalId}/status-history

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

Parameters

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

Response Statuses

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

Retrieve the Progress History for a Goal


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

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

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

print JSON.pretty_generate(result)


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

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

GET /goals/{goalId}/progress-history

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

Parameters

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

Response Statuses

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

Activity Definitions

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

Create an Activity Definition




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/activity-definitions', headers: headers, body: {"text":"Receive a flu shot","description":"A yearly flu vaccination is the best tool currently available to protect against influenza (flu), a serious disease that sickens millions of people each year. Flu vaccination can keep you from getting sick.","instantiatesUrl":"https://www.cdc.gov/flu/prevent/vaccine-benefits.htm","categories":[{"id":"11e818be2efb3d8f9c76653d4cc4a3f3"},{"id":"11e831f1150a0ec3a8a26933567de562"}],"disciplines":[{"id":"11c3a811c3900dc297c384c393c2bac2"},{"id":"11e8642c933ae8f48d534375f1bbef93"}],"supportingExternalReferences":[{"system":"https://dev.healthwise.net/services/services.content/v1/articles/","id":"4715932429582336"},{"system":"https://app.pluralsight.com/library/","id":"aws-developer-serverless-architecture-monitoring"}],"supportingReferences":[{"kind":"wellnessLearningModules#modules","id":"ecb8026a-64f9-11e8-adc0-fa7ae01bbebc"},{"kind":"education#content","id":"227ee4f0-6508-11e8-adc0-fa7ae01bbebc"}],"coding":[{"code":"11c3a811c3900dc297c384c393c2gac2","display":"Nutritional","system":"SNOMED CT"}],"status":"ACTIVE","targets":[{"measureTypeDescription":"Diastolic Blood Pressure","measureType":{"contextId":"6edf9160-1741-4538-97b1-cf0c2a557b16","conceptAlias":"HYPERTENSION_CLIN_DIA"},"detail":{"type":"NUMERIC","range":{"high":80,"low":70,"unitDescription":"mmHg","unit":{"contextId":"690aeffa-3029-c6aa-e053-5c2f47aa9044","conceptAlias":"MILLIMETER_MERCURY_MM_HG_UOM"}}}},{"measureTypeDescription":"Systolic Blood Pressure","measureType":{"contextId":"58c88d96-7ad0-4bfe-92d0-de52fca87642","conceptAlias":"HYPERTENSION_CLIN_SYS"},"detail":{"type":"BOOLEAN","boolean":{"value":"TRUE"}}}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/activity-definitions \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"text":"Receive a flu shot","description":"A yearly flu vaccination is the best tool currently available to protect against influenza (flu), a serious disease that sickens millions of people each year. Flu vaccination can keep you from getting sick.","instantiatesUrl":"https://www.cdc.gov/flu/prevent/vaccine-benefits.htm","categories":[{"id":"11e818be2efb3d8f9c76653d4cc4a3f3"},{"id":"11e831f1150a0ec3a8a26933567de562"}],"disciplines":[{"id":"11c3a811c3900dc297c384c393c2bac2"},{"id":"11e8642c933ae8f48d534375f1bbef93"}],"supportingExternalReferences":[{"system":"https://dev.healthwise.net/services/services.content/v1/articles/","id":"4715932429582336"},{"system":"https://app.pluralsight.com/library/","id":"aws-developer-serverless-architecture-monitoring"}],"supportingReferences":[{"kind":"wellnessLearningModules#modules","id":"ecb8026a-64f9-11e8-adc0-fa7ae01bbebc"},{"kind":"education#content","id":"227ee4f0-6508-11e8-adc0-fa7ae01bbebc"}],"coding":[{"code":"11c3a811c3900dc297c384c393c2gac2","display":"Nutritional","system":"SNOMED CT"}],"status":"ACTIVE","targets":[{"measureTypeDescription":"Diastolic Blood Pressure","measureType":{"contextId":"6edf9160-1741-4538-97b1-cf0c2a557b16","conceptAlias":"HYPERTENSION_CLIN_DIA"},"detail":{"type":"NUMERIC","range":{"high":80,"low":70,"unitDescription":"mmHg","unit":{"contextId":"690aeffa-3029-c6aa-e053-5c2f47aa9044","conceptAlias":"MILLIMETER_MERCURY_MM_HG_UOM"}}}},{"measureTypeDescription":"Systolic Blood Pressure","measureType":{"contextId":"58c88d96-7ad0-4bfe-92d0-de52fca87642","conceptAlias":"HYPERTENSION_CLIN_SYS"},"detail":{"type":"BOOLEAN","boolean":{"value":"TRUE"}}}]}

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

POST /activity-definitions

Creates an activity definition.

Parameters

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

Response Statuses

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

Response Headers

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

Retrieve a List of Activity Definitions


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

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

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

print JSON.pretty_generate(result)


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

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

GET /activity-definitions

Retrieves a list of activity definitions.

Parameters

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

Response Statuses

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

Update an Activity Definition




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

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

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/activity-definitions/11e8591a4d5e569c8f673f9b3f4603ec', headers: headers, body: {"text":"Receive a flu shot","description":"A yearly flu vaccination is the best tool currently available to protect against influenza (flu), a serious disease that sickens millions of people each year. Flu vaccination can keep you from getting sick.","instantiatesUrl":"https://www.cdc.gov/flu/prevent/vaccine-benefits.htm","categories":[{"id":"11e818be2efb3d8f9c76653d4cc4a3f3"},{"id":"11e831f1150a0ec3a8a26933567de562"}],"disciplines":[{"id":"11c3a811c3900dc297c384c393c2bac2"},{"id":"11e8642c933ae8f48d534375f1bbef93"}],"supportingExternalReferences":[{"system":"https://dev.healthwise.net/services/services.content/v1/articles/","id":"4715932429582336"},{"system":"https://app.pluralsight.com/library/","id":"aws-developer-serverless-architecture-monitoring"}],"supportingReferences":[{"kind":"wellnessLearningModules#modules","id":"ecb8026a-64f9-11e8-adc0-fa7ae01bbebc"},{"kind":"education#content","id":"227ee4f0-6508-11e8-adc0-fa7ae01bbebc"}],"coding":[{"code":"11c3a811c3900dc297c384c393c2gac2","display":"Nutritional","system":"SNOMED CT"}],"status":"ACTIVE","targets":[{"measureTypeDescription":"Diastolic Blood Pressure","measureType":{"contextId":"6edf9160-1741-4538-97b1-cf0c2a557b16","conceptAlias":"HYPERTENSION_CLIN_DIA"},"detail":{"type":"NUMERIC","range":{"high":80,"low":70,"unitDescription":"mmHg","unit":{"contextId":"690aeffa-3029-c6aa-e053-5c2f47aa9044","conceptAlias":"MILLIMETER_MERCURY_MM_HG_UOM"}}}},{"measureTypeDescription":"Systolic Blood Pressure","measureType":{"contextId":"58c88d96-7ad0-4bfe-92d0-de52fca87642","conceptAlias":"HYPERTENSION_CLIN_SYS"},"detail":{"type":"BOOLEAN","boolean":{"value":"TRUE"}}}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/activity-definitions/11e8591a4d5e569c8f673f9b3f4603ec \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \ \
-H 'If-Match: [object Object]' \
-d {"text":"Receive a flu shot","description":"A yearly flu vaccination is the best tool currently available to protect against influenza (flu), a serious disease that sickens millions of people each year. Flu vaccination can keep you from getting sick.","instantiatesUrl":"https://www.cdc.gov/flu/prevent/vaccine-benefits.htm","categories":[{"id":"11e818be2efb3d8f9c76653d4cc4a3f3"},{"id":"11e831f1150a0ec3a8a26933567de562"}],"disciplines":[{"id":"11c3a811c3900dc297c384c393c2bac2"},{"id":"11e8642c933ae8f48d534375f1bbef93"}],"supportingExternalReferences":[{"system":"https://dev.healthwise.net/services/services.content/v1/articles/","id":"4715932429582336"},{"system":"https://app.pluralsight.com/library/","id":"aws-developer-serverless-architecture-monitoring"}],"supportingReferences":[{"kind":"wellnessLearningModules#modules","id":"ecb8026a-64f9-11e8-adc0-fa7ae01bbebc"},{"kind":"education#content","id":"227ee4f0-6508-11e8-adc0-fa7ae01bbebc"}],"coding":[{"code":"11c3a811c3900dc297c384c393c2gac2","display":"Nutritional","system":"SNOMED CT"}],"status":"ACTIVE","targets":[{"measureTypeDescription":"Diastolic Blood Pressure","measureType":{"contextId":"6edf9160-1741-4538-97b1-cf0c2a557b16","conceptAlias":"HYPERTENSION_CLIN_DIA"},"detail":{"type":"NUMERIC","range":{"high":80,"low":70,"unitDescription":"mmHg","unit":{"contextId":"690aeffa-3029-c6aa-e053-5c2f47aa9044","conceptAlias":"MILLIMETER_MERCURY_MM_HG_UOM"}}}},{"measureTypeDescription":"Systolic Blood Pressure","measureType":{"contextId":"58c88d96-7ad0-4bfe-92d0-de52fca87642","conceptAlias":"HYPERTENSION_CLIN_SYS"},"detail":{"type":"BOOLEAN","boolean":{"value":"TRUE"}}}]}

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

PUT /activity-definitions/{activityDefinitionId}

Updates a single activity definition.

Parameters

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

Response Statuses

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

Response Headers

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

Retrieve a Single Activity Definition


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

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

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

print JSON.pretty_generate(result)


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

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

GET /activity-definitions/{activityDefinitionId}

Retrieves a single activity definition by ID.

Parameters

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

Response Statuses

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

Response Headers

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

Goal Definitions

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

Create a Goal Definition




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/goal-definitions', headers: headers, body: {"text":"Receive a flu shot","categories":[{"id":"11e818be2efb3d8f9c76653d4cc4a3f3"},{"id":"11e831f1150a0ec3a8a26933567de562"}],"disciplines":[{"id":"11c3a811c3900dc297c384c393c2bac2"},{"id":"11e8642c933ae8f48d534375f1bbef93"}],"coding":[{"code":"11c3a811c3900dc297c384c393c2gac2","display":"Nutritional","system":"SNOMED CT"}],"status":"ACTIVE","targets":[{"measureTypeDescription":"Diastolic Blood Pressure","measureType":{"contextId":"6edf9160-1741-4538-97b1-cf0c2a557b16","conceptAlias":"HYPERTENSION_CLIN_DIA"},"detail":{"type":"NUMERIC","range":{"high":80,"low":70,"unitDescription":"mmHg","unit":{"contextId":"690aeffa-3029-c6aa-e053-5c2f47aa9044","conceptAlias":"MILLIMETER_MERCURY_MM_HG_UOM"}}}},{"measureTypeDescription":"Systolic Blood Pressure","measureType":{"contextId":"58c88d96-7ad0-4bfe-92d0-de52fca87642","conceptAlias":"HYPERTENSION_CLIN_SYS"},"detail":{"type":"BOOLEAN","boolean":{"value":"TRUE"}}}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/goal-definitions \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"text":"Receive a flu shot","categories":[{"id":"11e818be2efb3d8f9c76653d4cc4a3f3"},{"id":"11e831f1150a0ec3a8a26933567de562"}],"disciplines":[{"id":"11c3a811c3900dc297c384c393c2bac2"},{"id":"11e8642c933ae8f48d534375f1bbef93"}],"coding":[{"code":"11c3a811c3900dc297c384c393c2gac2","display":"Nutritional","system":"SNOMED CT"}],"status":"ACTIVE","targets":[{"measureTypeDescription":"Diastolic Blood Pressure","measureType":{"contextId":"6edf9160-1741-4538-97b1-cf0c2a557b16","conceptAlias":"HYPERTENSION_CLIN_DIA"},"detail":{"type":"NUMERIC","range":{"high":80,"low":70,"unitDescription":"mmHg","unit":{"contextId":"690aeffa-3029-c6aa-e053-5c2f47aa9044","conceptAlias":"MILLIMETER_MERCURY_MM_HG_UOM"}}}},{"measureTypeDescription":"Systolic Blood Pressure","measureType":{"contextId":"58c88d96-7ad0-4bfe-92d0-de52fca87642","conceptAlias":"HYPERTENSION_CLIN_SYS"},"detail":{"type":"BOOLEAN","boolean":{"value":"TRUE"}}}]}

{
  "id": "11e8902c9e2908c69718f13503066bee",
  "text": "Receive a flu shot",
  "status": "ACTIVE",
  "categories": [
    {
      "id": "11e8902c9e2908c69718f13503066bee",
      "text": "Nutritional",
      "status": "ACTIVE",
      "coding": [
        {
          "code": "11c3a7c39225c391387341c2aac323fds",
          "system": "SNOMED CT",
          "display": "Nutritional"
        }
      ]
    }
  ],
  "disciplines": [
    {
      "id": "11e8902c9e2908c69718f13503066bef",
      "text": "Anesthesiology",
      "status": "ACTIVE",
      "coding": [
        {
          "code": "11c3a7c39225c391387341c2aac323fds",
          "system": "SNOMED CT",
          "display": "Anesthesiology"
        }
      ]
    }
  ],
  "coding": [
    {
      "code": "11c3a7c39225c391387341c2aac323fds",
      "system": "SNOMED CT",
      "display": "Nutritional"
    }
  ],
  "targets": [
    {
      "measureTypeDescription": "HbA1c",
      "measureType": {
        "contextId": "d1ef6dd8-a18c-429e-9a95-c77a5439956d",
        "conceptAlias": "HEMOGLOBIN_A1C_PCT_BLOOD_OBSTYPE"
      },
      "detail": {
        "type": "NUMERIC",
        "numeric": {
          "value": 5.6,
          "operator": "<",
          "unitDescription": "%",
          "unit": {
            "contextId": "30517bf1-0c68-4d73-9557-456902a50563",
            "conceptAlias": "PERCENT_UOM"
          }
        }
      }
    }
  ],
  "targetGroups": [
    {
      "name": "Blood pressure systolic & diastolic",
      "targets": [
        {
          "measureTypeDescription": "Diastolic Blood Pressure",
          "measureType": {
            "contextId": "6edf9160-1741-4538-97b1-cf0c2a557b16",
            "conceptAlias": "HYPERTENSION_CLIN_DIA"
          },
          "detail": {
            "range": {
              "high": "80",
              "low": "70",
              "unitDescription": "mmHg",
              "unit": {
                "contextId": "690aeffa-3029-c6aa-e053-5c2f47aa9044",
                "conceptAlias": "MILLIMETER_MERCURY_MM_HG_UOM"
              }
            }
          }
        },
        {
          "measureTypeDescription": "Systolic Blood Pressure",
          "measureType": {
            "contextId": "58c88d96-7ad0-4bfe-92d0-de52fca87642",
            "conceptAlias": "HYPERTENSION_CLIN_SYS"
          },
          "detail": {
            "range": {
              "high": "130",
              "low": "120",
              "unitDescription": "mmHg",
              "unit": {
                "contextId": "690aeffa-3029-c6aa-e053-5c2f47aa9044",
                "conceptAlias": "MILLIMETER_MERCURY_MM_HG_UOM"
              }
            }
          }
        }
      ]
    }
  ]
}

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


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

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

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

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "11e8902c9e2908c69718f13503066bee",
      "text": "Receive a flu shot",
      "status": "ACTIVE",
      "categories": [
        {
          "id": "11e8902c9e2908c69718f13503066bee",
          "text": "Nutritional",
          "status": "ACTIVE",
          "coding": [
            {
              "code": "11c3a7c39225c391387341c2aac323fds",
              "system": "SNOMED CT",
              "display": "Nutritional"
            }
          ]
        }
      ],
      "disciplines": [
        {
          "id": "11e8902c9e2908c69718f13503066bef",
          "text": "Anesthesiology",
          "status": "ACTIVE",
          "coding": [
            {
              "code": "11c3a7c39225c391387341c2aac323fds",
              "system": "SNOMED CT",
              "display": "Anesthesiology"
            }
          ]
        }
      ],
      "coding": [
        {
          "code": "11c3a7c39225c391387341c2aac323fds",
          "system": "SNOMED CT",
          "display": "Nutritional"
        }
      ],
      "targets": [
        {
          "measureTypeDescription": "HbA1c",
          "measureType": {
            "contextId": "d1ef6dd8-a18c-429e-9a95-c77a5439956d",
            "conceptAlias": "HEMOGLOBIN_A1C_PCT_BLOOD_OBSTYPE"
          },
          "detail": {
            "type": "NUMERIC",
            "numeric": {
              "value": 5.6,
              "operator": "<",
              "unitDescription": "%",
              "unit": {
                "contextId": "30517bf1-0c68-4d73-9557-456902a50563",
                "conceptAlias": "PERCENT_UOM"
              }
            }
          }
        }
      ],
      "targetGroups": [
        {
          "name": "Blood pressure systolic & diastolic",
          "targets": [
            {
              "measureTypeDescription": "Diastolic Blood Pressure",
              "measureType": {
                "contextId": "6edf9160-1741-4538-97b1-cf0c2a557b16",
                "conceptAlias": "HYPERTENSION_CLIN_DIA"
              },
              "detail": {
                "range": {
                  "high": "80",
                  "low": "70",
                  "unitDescription": "mmHg",
                  "unit": {
                    "contextId": "690aeffa-3029-c6aa-e053-5c2f47aa9044",
                    "conceptAlias": "MILLIMETER_MERCURY_MM_HG_UOM"
                  }
                }
              }
            },
            {
              "measureTypeDescription": "Systolic Blood Pressure",
              "measureType": {
                "contextId": "58c88d96-7ad0-4bfe-92d0-de52fca87642",
                "conceptAlias": "HYPERTENSION_CLIN_SYS"
              },
              "detail": {
                "range": {
                  "high": "130",
                  "low": "120",
                  "unitDescription": "mmHg",
                  "unit": {
                    "contextId": "690aeffa-3029-c6aa-e053-5c2f47aa9044",
                    "conceptAlias": "MILLIMETER_MERCURY_MM_HG_UOM"
                  }
                }
              }
            }
          ]
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/goal-definitions?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/goal-definitions?offset=0&limit=20"
}

GET /goal-definitions

Retrieves a list of goal definitions.

Parameters

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

Response Statuses

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

Update a Goal Definition




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

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

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/goal-definitions/11e8591a4d5e569c8f673f9b3f4603ec', headers: headers, body: {"text":"Receive a flu shot","categories":[{"id":"11e818be2efb3d8f9c76653d4cc4a3f3"},{"id":"11e831f1150a0ec3a8a26933567de562"}],"disciplines":[{"id":"11c3a811c3900dc297c384c393c2bac2"},{"id":"11e8642c933ae8f48d534375f1bbef93"}],"coding":[{"code":"11c3a811c3900dc297c384c393c2gac2","display":"Nutritional","system":"SNOMED CT"}],"status":"ACTIVE","targets":[{"measureTypeDescription":"Diastolic Blood Pressure","measureType":{"contextId":"6edf9160-1741-4538-97b1-cf0c2a557b16","conceptAlias":"HYPERTENSION_CLIN_DIA"},"detail":{"type":"NUMERIC","range":{"high":80,"low":70,"unitDescription":"mmHg","unit":{"contextId":"690aeffa-3029-c6aa-e053-5c2f47aa9044","conceptAlias":"MILLIMETER_MERCURY_MM_HG_UOM"}}}},{"measureTypeDescription":"Systolic Blood Pressure","measureType":{"contextId":"58c88d96-7ad0-4bfe-92d0-de52fca87642","conceptAlias":"HYPERTENSION_CLIN_SYS"},"detail":{"type":"BOOLEAN","boolean":{"value":"TRUE"}}}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/goal-definitions/11e8591a4d5e569c8f673f9b3f4603ec \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \ \
-H 'If-Match: [object Object]' \
-d {"text":"Receive a flu shot","categories":[{"id":"11e818be2efb3d8f9c76653d4cc4a3f3"},{"id":"11e831f1150a0ec3a8a26933567de562"}],"disciplines":[{"id":"11c3a811c3900dc297c384c393c2bac2"},{"id":"11e8642c933ae8f48d534375f1bbef93"}],"coding":[{"code":"11c3a811c3900dc297c384c393c2gac2","display":"Nutritional","system":"SNOMED CT"}],"status":"ACTIVE","targets":[{"measureTypeDescription":"Diastolic Blood Pressure","measureType":{"contextId":"6edf9160-1741-4538-97b1-cf0c2a557b16","conceptAlias":"HYPERTENSION_CLIN_DIA"},"detail":{"type":"NUMERIC","range":{"high":80,"low":70,"unitDescription":"mmHg","unit":{"contextId":"690aeffa-3029-c6aa-e053-5c2f47aa9044","conceptAlias":"MILLIMETER_MERCURY_MM_HG_UOM"}}}},{"measureTypeDescription":"Systolic Blood Pressure","measureType":{"contextId":"58c88d96-7ad0-4bfe-92d0-de52fca87642","conceptAlias":"HYPERTENSION_CLIN_SYS"},"detail":{"type":"BOOLEAN","boolean":{"value":"TRUE"}}}]}

{
  "id": "11e8902c9e2908c69718f13503066bee",
  "text": "Receive a flu shot",
  "status": "ACTIVE",
  "categories": [
    {
      "id": "11e8902c9e2908c69718f13503066bee",
      "text": "Nutritional",
      "status": "ACTIVE",
      "coding": [
        {
          "code": "11c3a7c39225c391387341c2aac323fds",
          "system": "SNOMED CT",
          "display": "Nutritional"
        }
      ]
    }
  ],
  "disciplines": [
    {
      "id": "11e8902c9e2908c69718f13503066bef",
      "text": "Anesthesiology",
      "status": "ACTIVE",
      "coding": [
        {
          "code": "11c3a7c39225c391387341c2aac323fds",
          "system": "SNOMED CT",
          "display": "Anesthesiology"
        }
      ]
    }
  ],
  "coding": [
    {
      "code": "11c3a7c39225c391387341c2aac323fds",
      "system": "SNOMED CT",
      "display": "Nutritional"
    }
  ],
  "targets": [
    {
      "measureTypeDescription": "HbA1c",
      "measureType": {
        "contextId": "d1ef6dd8-a18c-429e-9a95-c77a5439956d",
        "conceptAlias": "HEMOGLOBIN_A1C_PCT_BLOOD_OBSTYPE"
      },
      "detail": {
        "type": "NUMERIC",
        "numeric": {
          "value": 5.6,
          "operator": "<",
          "unitDescription": "%",
          "unit": {
            "contextId": "30517bf1-0c68-4d73-9557-456902a50563",
            "conceptAlias": "PERCENT_UOM"
          }
        }
      }
    }
  ],
  "targetGroups": [
    {
      "name": "Blood pressure systolic & diastolic",
      "targets": [
        {
          "measureTypeDescription": "Diastolic Blood Pressure",
          "measureType": {
            "contextId": "6edf9160-1741-4538-97b1-cf0c2a557b16",
            "conceptAlias": "HYPERTENSION_CLIN_DIA"
          },
          "detail": {
            "range": {
              "high": "80",
              "low": "70",
              "unitDescription": "mmHg",
              "unit": {
                "contextId": "690aeffa-3029-c6aa-e053-5c2f47aa9044",
                "conceptAlias": "MILLIMETER_MERCURY_MM_HG_UOM"
              }
            }
          }
        },
        {
          "measureTypeDescription": "Systolic Blood Pressure",
          "measureType": {
            "contextId": "58c88d96-7ad0-4bfe-92d0-de52fca87642",
            "conceptAlias": "HYPERTENSION_CLIN_SYS"
          },
          "detail": {
            "range": {
              "high": "130",
              "low": "120",
              "unitDescription": "mmHg",
              "unit": {
                "contextId": "690aeffa-3029-c6aa-e053-5c2f47aa9044",
                "conceptAlias": "MILLIMETER_MERCURY_MM_HG_UOM"
              }
            }
          }
        }
      ]
    }
  ]
}

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


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

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

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

print JSON.pretty_generate(result)


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

{
  "id": "11e8902c9e2908c69718f13503066bee",
  "text": "Receive a flu shot",
  "status": "ACTIVE",
  "categories": [
    {
      "id": "11e8902c9e2908c69718f13503066bee",
      "text": "Nutritional",
      "status": "ACTIVE",
      "coding": [
        {
          "code": "11c3a7c39225c391387341c2aac323fds",
          "system": "SNOMED CT",
          "display": "Nutritional"
        }
      ]
    }
  ],
  "disciplines": [
    {
      "id": "11e8902c9e2908c69718f13503066bef",
      "text": "Anesthesiology",
      "status": "ACTIVE",
      "coding": [
        {
          "code": "11c3a7c39225c391387341c2aac323fds",
          "system": "SNOMED CT",
          "display": "Anesthesiology"
        }
      ]
    }
  ],
  "coding": [
    {
      "code": "11c3a7c39225c391387341c2aac323fds",
      "system": "SNOMED CT",
      "display": "Nutritional"
    }
  ],
  "targets": [
    {
      "measureTypeDescription": "HbA1c",
      "measureType": {
        "contextId": "d1ef6dd8-a18c-429e-9a95-c77a5439956d",
        "conceptAlias": "HEMOGLOBIN_A1C_PCT_BLOOD_OBSTYPE"
      },
      "detail": {
        "type": "NUMERIC",
        "numeric": {
          "value": 5.6,
          "operator": "<",
          "unitDescription": "%",
          "unit": {
            "contextId": "30517bf1-0c68-4d73-9557-456902a50563",
            "conceptAlias": "PERCENT_UOM"
          }
        }
      }
    }
  ],
  "targetGroups": [
    {
      "name": "Blood pressure systolic & diastolic",
      "targets": [
        {
          "measureTypeDescription": "Diastolic Blood Pressure",
          "measureType": {
            "contextId": "6edf9160-1741-4538-97b1-cf0c2a557b16",
            "conceptAlias": "HYPERTENSION_CLIN_DIA"
          },
          "detail": {
            "range": {
              "high": "80",
              "low": "70",
              "unitDescription": "mmHg",
              "unit": {
                "contextId": "690aeffa-3029-c6aa-e053-5c2f47aa9044",
                "conceptAlias": "MILLIMETER_MERCURY_MM_HG_UOM"
              }
            }
          }
        },
        {
          "measureTypeDescription": "Systolic Blood Pressure",
          "measureType": {
            "contextId": "58c88d96-7ad0-4bfe-92d0-de52fca87642",
            "conceptAlias": "HYPERTENSION_CLIN_SYS"
          },
          "detail": {
            "range": {
              "high": "130",
              "low": "120",
              "unitDescription": "mmHg",
              "unit": {
                "contextId": "690aeffa-3029-c6aa-e053-5c2f47aa9044",
                "conceptAlias": "MILLIMETER_MERCURY_MM_HG_UOM"
              }
            }
          }
        }
      ]
    }
  ]
}

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.

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




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

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

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

print JSON.pretty_generate(result)




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

{
  "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


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

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

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

print JSON.pretty_generate(result)


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

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

GET /disciplines

Retrieves a list of disciplines.

Parameters

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

Response Statuses

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

Update a Discipline




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

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

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

print JSON.pretty_generate(result)




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

{
  "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


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

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

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

print JSON.pretty_generate(result)


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

{
  "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:

Optimism
Resourcefulness
Physically Active

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


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

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

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

print JSON.pretty_generate(result)


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

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

GET /consumers/{consumerId}/strengths

Retrieves a list of strengths for a consumer.

Parameters

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

Response Statuses

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

Create a Strength




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

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

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

print JSON.pretty_generate(result)




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

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

POST /consumers/{consumerId}/strengths

Creates a strength for a consumer.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
consumerId	path	string	true	N/A	The ID of a Health Data Intelligence 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 ETag of a specific version of the strength.

Update a Strength




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

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

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

print JSON.pretty_generate(result)




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

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

PUT /strengths/{strengthId}

Updates a single strength.

Parameters

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

Response Statuses

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

Response Headers

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

Retrieve a Single Strength


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

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

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

print JSON.pretty_generate(result)


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

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

GET /strengths/{strengthId}

Retrieves a single strength.

Parameters

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

Response Statuses

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

Response Headers

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

Strength Definitions

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

Create a Strength Definition




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

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

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

print JSON.pretty_generate(result)




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

{
  "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


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

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

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

print JSON.pretty_generate(result)


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

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

GET /strength-definitions

Retrieves a list of strength definitions.

Parameters

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

Response Statuses

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

Update a Strength Definition




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

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

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

print JSON.pretty_generate(result)




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

{
  "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


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

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

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

print JSON.pretty_generate(result)


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

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

GET /strength-definitions/{strengthDefinitionId}

Retrieves a single strength definition by ID.

Parameters

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

Response Statuses

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

Response Headers

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

Measure Suggestion Definitions

A measure suggestion definition is a mapping between a plan entity and a HealtheRegistries measure that is not currently met.

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

A measure suggestion set is a group of a measure suggestion definitions that can be associated with specific patients and that allows you to focus specific measure suggestion definitions on a subset of patients.

Create a Measure Suggestion Definition




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

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

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

print JSON.pretty_generate(result)




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

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

POST /measure-suggestion-definitions

Creates a measure suggestion definition.

Parameters

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

Response Statuses

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

Retrieve a List of Measure Suggestion Definitions


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

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

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

print JSON.pretty_generate(result)


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

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

GET /measure-suggestion-definitions

Retrieves a list of measure suggestion definitions.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
status	query	array[string]	false	N/A	Filters the retrieved measure suggestion definitions by status.	ACTIVE, INACTIVE
programId	query	array[string]	false	N/A	Filters the retrieved measure suggestion definitions by program ID.	-
measureId	query	array[string]	false	N/A	Filters the retrieved measure suggestion definitions by measure ID. If measure ID is specified, program ID 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 Measure Suggestion Definitions	MeasureSuggestionDefinitions
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Retrieve a Single Measure Suggestion Definition


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

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

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

print JSON.pretty_generate(result)


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

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

GET /measure-suggestion-definitions/{measureSuggestionDefinitionId}

Retrieves a single measure suggestion definition.

Parameters

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

Response Statuses

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

Update a Measure Suggestion Definition




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

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

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

print JSON.pretty_generate(result)




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

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

PUT /measure-suggestion-definitions/{measureSuggestionDefinitionId}

Updates a measure suggestion definition.

Parameters

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

Response Statuses

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

Response Headers

Status	Header	Type	Format	Description
200	If-Match	string		The version value of the current record.

Retrieve a List of Measure Suggestion Sets


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

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

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

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "3564cbe3-5114-4073-88c9-a523e7f4a000",
      "name": "3564cbe3-5114-4073-88c9-a523e7f4a000",
      "patients": [
        {
          "id": "fb10d814-385f-48ef-a90b-302389091921"
        },
        {
          "id": "8b1361ea-c239-4867-8224-24a6fc2d1895"
        }
      ],
      "status": "ACTIVE",
      "updatedAt": "2018-07-25T17:03:14.120Z",
      "createdAt": "2018-07-25T17:03:14.120Z",
      "version": 1
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/plan-suggestion/v1/measure-suggestion-sets?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/plan-suggestion/v1/measure-suggestion-sets?offset=0&limit=20"
}

GET /measure-suggestion-sets

Retrieves a list of measure suggestion sets.

Parameters

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

Response Statuses

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

Create a Measure Suggestion Set




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/measure-suggestion-sets', headers: headers, body: {"name":"Alpha tester","patients":[{"id":"fb10d814-385f-48ef-a90b-302389091921"},{"id":"8b1361ea-c239-4867-8224-24a6fc2d1895"}],"status":"ACTIVE"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/measure-suggestion-sets \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Alpha tester","patients":[{"id":"fb10d814-385f-48ef-a90b-302389091921"},{"id":"8b1361ea-c239-4867-8224-24a6fc2d1895"}],"status":"ACTIVE"}

{
  "id": "3564cbe3-5114-4073-88c9-a523e7f4a000",
  "name": "3564cbe3-5114-4073-88c9-a523e7f4a000",
  "patients": [
    {
      "id": "fb10d814-385f-48ef-a90b-302389091921"
    },
    {
      "id": "8b1361ea-c239-4867-8224-24a6fc2d1895"
    }
  ],
  "status": "ACTIVE",
  "updatedAt": "2018-07-25T17:03:14.120Z",
  "createdAt": "2018-07-25T17:03:14.120Z",
  "version": 1
}

POST /measure-suggestion-sets

Creates a measure suggestion set.

Parameters

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

Response Statuses

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

Update a Measure Suggestion Set




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

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

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/measure-suggestion-sets/11c819be2efb3d8f9c76653d4cc4a3f3', headers: headers, body: {"name":"Alpha tester","patients":[{"id":"fb10d814-385f-48ef-a90b-302389091921"},{"id":"8b1361ea-c239-4867-8224-24a6fc2d1895"}],"status":"ACTIVE"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/measure-suggestion-sets/11c819be2efb3d8f9c76653d4cc4a3f3 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Alpha tester","patients":[{"id":"fb10d814-385f-48ef-a90b-302389091921"},{"id":"8b1361ea-c239-4867-8224-24a6fc2d1895"}],"status":"ACTIVE"}

{
  "id": "3564cbe3-5114-4073-88c9-a523e7f4a000",
  "name": "3564cbe3-5114-4073-88c9-a523e7f4a000",
  "patients": [
    {
      "id": "fb10d814-385f-48ef-a90b-302389091921"
    },
    {
      "id": "8b1361ea-c239-4867-8224-24a6fc2d1895"
    }
  ],
  "status": "ACTIVE",
  "updatedAt": "2018-07-25T17:03:14.120Z",
  "createdAt": "2018-07-25T17:03:14.120Z",
  "version": 1
}

PUT /measure-suggestion-sets/{measureSuggestionSetId}

Updates a measure suggestion set.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
200	OK	Update a Measure Suggestion Set	MeasureSuggestionSet
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	If-Match	string		The version value of the current record.

Barrier Definitions

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

Retrieve a List of Barrier Definitions


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

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

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

print JSON.pretty_generate(result)


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

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

GET /barrier-definitions

Retrieves a list of barrier definitions.

Parameters

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

Response Statuses

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

Create a Barrier Definition




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

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

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

print JSON.pretty_generate(result)




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

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

POST /barrier-definitions

Creates a barrier definition.

Parameters

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

Response Statuses

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

Response Headers

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

Update a Barrier Definition




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

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

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

print JSON.pretty_generate(result)




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

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

PUT /barrier-definitions/{barrierDefinitionId}

Updates a single barrier definition.

Parameters

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

Response Statuses

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

Response Headers

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

Retrieve a Single Barrier Definition


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

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

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

print JSON.pretty_generate(result)


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

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

GET /barrier-definitions/{barrierDefinitionId}

Retrieves a single barrier definition by ID.

Parameters

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

Response Statuses

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

Response Headers

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

Care Plans

Plans of Care are a comprehensive approach to define expected outcomes and planning to meet a patient’s individualized goals. Plans of Care provide a collaborative process to prioritize and promote beneficial outcomes for a patient (or consumer) that may include multiple disciplines or professions to support the patient’s needs in a holistic and interactive view.

A care plan is a methodical approach to resolving or managing a concern. The name of the plan of care establishes the intention and measures a care team has for a patient concern. The plan includes elements such as goals, interventions (activities), targets, and expectations to meet outcomes. Users can select elements from a plan template to create a plan for a patient.

A patient may have a single or multiple care plans due to the complexity or treatment method for a condition.A patient may also have no current plans of care if there are no ongoing medical concerns.

A plan name assists clinicians identifying the plan type. Common types of plans of care include someof the following:

Condition/Concern being addressed (Example: Type 2 Diabetes Inpatient Management Plan)
Acuity/Level of Care (Example: ICU Plan of Care vs Rehab Plan of Care)
Treatment (Example: Blood Transfusion Plan of Care which is different from OB (Obstetrical) Active Labor Planor Acute Pain IPOC)
Protocol (Example: Falls Risk Protocol)
Specialty/Body System (Example: OB (Obstetrical) Plans of Care, Cardiology Plan, EENT Medical Plan of Care)
Episode/Chronology (Example: Pre-Operative Surgery Plan of Care vs Post-Operative Surgery Plan of Care)

Update a Care Plan




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

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

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/care-plans/11e8901dafad94f7a9b701d255a00ad0', headers: headers, body: {"description":"Pain maintained at or below acceptable pain rating","type":"ONGOING","status":"ACTIVE","updatedBy":{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}},"healthConcerns":[{"id":"11e8901b64b1ca0b9c300d1ad3125a48"}],"goals":[{"id":"11e8902c79c4ee348fe5cf0da3dac545"}],"dueDate":"2017-12-20","updatedSourceEncounter":{"id":"11e8901b64b1ca0b9c300d1ad3125a48","dataPartitionId":"4de3a1ab-5783-4e30-ba60-551ab1cf86fc"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/care-plans/11e8901dafad94f7a9b701d255a00ad0 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \ \
-H 'If-Match: [object Object]' \
-d {"description":"Pain maintained at or below acceptable pain rating","type":"ONGOING","status":"ACTIVE","updatedBy":{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}},"healthConcerns":[{"id":"11e8901b64b1ca0b9c300d1ad3125a48"}],"goals":[{"id":"11e8902c79c4ee348fe5cf0da3dac545"}],"dueDate":"2017-12-20","updatedSourceEncounter":{"id":"11e8901b64b1ca0b9c300d1ad3125a48","dataPartitionId":"4de3a1ab-5783-4e30-ba60-551ab1cf86fc"}}

{
  "id": "11e8902c9e2908c69718f13503066bee",
  "consumer": {
    "id": "d8454f2a-665c-49d4-87db-8c167feae10e"
  },
  "description": "Diabetes Care Plan",
  "type": "ONGOING",
  "status": "ACTIVE",
  "version": 1,
  "progress": "PROGRESSING",
  "priority": "HIGH",
  "originatingSourceEncounter": {
    "id": "09920f12-006f-44za-019d-12kdk23094ee1",
    "dataPartitionId": "4de3a1ab-5783-4e30-ba60-551ab1cf86fc"
  },
  "updatedSourceEncounter": {
    "id": "09920f12-006f-44za-019d-12kdk23094ee2",
    "dataPartitionId": "4de3a1ab-5783-4e30-ba60-551ab1cf86fc"
  },
  "createdAt": "2018-07-25T17:03:14.120Z",
  "createdBy": {
    "type": "PERSONNEL",
    "reference": {
      "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
    }
  },
  "updatedAt": "2018-07-25T17:03:14.120Z",
  "updatedBy": {
    "type": "PERSONNEL",
    "reference": {
      "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
    }
  },
  "healthConcerns": [
    {
      "id": "11e8901b64b1ca0b9c300d1ad3125a48"
    }
  ],
  "goals": [
    {
      "id": "11e8902c79c4ee348fe5cf0da3dac545"
    }
  ]
}

PUT /consumers/{consumerId}/care-plans/{carePlanId}

Updates a care plan.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
If-Match	header	string	true	N/A	The specific version of the care plan to update.	-
consumerId	path	string	true	N/A	The ID of a Health Data Intelligence consumer. See Consumer API for more information.	-
carePlanId	path	string	true	N/A	The ID of the care plan.	-
body	body	putConsumersConsumeridCarePlans	true	N/A	No description	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	Update a Care Plan	CarePlan
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 Care Plan.

Retrieve a Single Care Plan


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

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

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

print JSON.pretty_generate(result)


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

{
  "id": "11e8902c9e2908c69718f13503066bee",
  "consumer": {
    "id": "d8454f2a-665c-49d4-87db-8c167feae10e"
  },
  "description": "Diabetes Care Plan",
  "type": "ONGOING",
  "status": "ACTIVE",
  "version": 1,
  "progress": "PROGRESSING",
  "priority": "HIGH",
  "originatingSourceEncounter": {
    "id": "09920f12-006f-44za-019d-12kdk23094ee1",
    "dataPartitionId": "4de3a1ab-5783-4e30-ba60-551ab1cf86fc"
  },
  "updatedSourceEncounter": {
    "id": "09920f12-006f-44za-019d-12kdk23094ee2",
    "dataPartitionId": "4de3a1ab-5783-4e30-ba60-551ab1cf86fc"
  },
  "createdAt": "2018-07-25T17:03:14.120Z",
  "createdBy": {
    "type": "PERSONNEL",
    "reference": {
      "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
    }
  },
  "updatedAt": "2018-07-25T17:03:14.120Z",
  "updatedBy": {
    "type": "PERSONNEL",
    "reference": {
      "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
    }
  },
  "healthConcerns": [
    {
      "id": "11e8901b64b1ca0b9c300d1ad3125a48"
    }
  ],
  "goals": [
    {
      "id": "11e8902c79c4ee348fe5cf0da3dac545"
    }
  ]
}

GET /consumers/{consumerId}/care-plans/{carePlanId}

Retrieves a single care plan by ID.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
consumerId	path	string	true	N/A	The ID of a Health Data Intelligence consumer. See Consumer API for more information.	-
carePlanId	path	string	true	N/A	The ID of the care plan.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	Retrieve a Single Care Plan	CarePlan
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 care plan.

Retrieve a List of Care Plans


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

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

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

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "11e8902c9e2908c69718f13503066bee",
      "consumer": {
        "id": "d8454f2a-665c-49d4-87db-8c167feae10e"
      },
      "description": "Diabetes Care Plan",
      "type": "ONGOING",
      "status": "ACTIVE",
      "version": 1,
      "progress": "PROGRESSING",
      "priority": "HIGH",
      "originatingSourceEncounter": {
        "id": "09920f12-006f-44za-019d-12kdk23094ee1",
        "dataPartitionId": "4de3a1ab-5783-4e30-ba60-551ab1cf86fc"
      },
      "updatedSourceEncounter": {
        "id": "09920f12-006f-44za-019d-12kdk23094ee2",
        "dataPartitionId": "4de3a1ab-5783-4e30-ba60-551ab1cf86fc"
      },
      "createdAt": "2018-07-25T17:03:14.120Z",
      "createdBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "updatedAt": "2018-07-25T17:03:14.120Z",
      "updatedBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "healthConcerns": [
        {
          "id": "11e8901b64b1ca0b9c300d1ad3125a48"
        }
      ],
      "goals": [
        {
          "id": "11e8902c79c4ee348fe5cf0da3dac545"
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/care-plans?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/care-plans?offset=0&limit=20"
}

GET /consumers/{consumerId}/care-plans

Retrieves a list of care plans.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	query	array[string]	false	N/A	Filters by the ID of the care plan.	-
status	query	array[string]	false	N/A	Filters the retrieved care plans by status.	ACTIVE, COMPLETED, INACTIVE, IN_ERROR, REJECTED, SUSPENDED
type	query	array[string]	false	N/A	Filters the retrieved care plans by type.	VISIT, ONGOING
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.	-
consumerId	path	integer(int32)	true	N/A	No description	-

Response Statuses

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

Create a Care Plan




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/care-plans', headers: headers, body: {"description":"Pain maintained at or below acceptable pain rating","type":"ONGOING","status":"ACTIVE","createdBy":{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}},"healthConcerns":[{"id":"11e8901b64b1ca0b9c300d1ad3125a48"}],"goals":[{"id":"11e8902c79c4ee348fe5cf0da3dac545"}],"dueDate":"2017-12-20","originatingSourceEncounter":{"id":"11e8901b64b1ca0b9c300d1ad3125a48","dataPartitionId":"4de3a1ab-5783-4e30-ba60-551ab1cf86fc"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/care-plans \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"description":"Pain maintained at or below acceptable pain rating","type":"ONGOING","status":"ACTIVE","createdBy":{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}},"healthConcerns":[{"id":"11e8901b64b1ca0b9c300d1ad3125a48"}],"goals":[{"id":"11e8902c79c4ee348fe5cf0da3dac545"}],"dueDate":"2017-12-20","originatingSourceEncounter":{"id":"11e8901b64b1ca0b9c300d1ad3125a48","dataPartitionId":"4de3a1ab-5783-4e30-ba60-551ab1cf86fc"}}

{
  "id": "11e8902c9e2908c69718f13503066bee",
  "consumer": {
    "id": "d8454f2a-665c-49d4-87db-8c167feae10e"
  },
  "description": "Diabetes Care Plan",
  "type": "ONGOING",
  "status": "ACTIVE",
  "version": 1,
  "progress": "PROGRESSING",
  "priority": "HIGH",
  "originatingSourceEncounter": {
    "id": "09920f12-006f-44za-019d-12kdk23094ee1",
    "dataPartitionId": "4de3a1ab-5783-4e30-ba60-551ab1cf86fc"
  },
  "updatedSourceEncounter": {
    "id": "09920f12-006f-44za-019d-12kdk23094ee2",
    "dataPartitionId": "4de3a1ab-5783-4e30-ba60-551ab1cf86fc"
  },
  "createdAt": "2018-07-25T17:03:14.120Z",
  "createdBy": {
    "type": "PERSONNEL",
    "reference": {
      "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
    }
  },
  "updatedAt": "2018-07-25T17:03:14.120Z",
  "updatedBy": {
    "type": "PERSONNEL",
    "reference": {
      "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
    }
  },
  "healthConcerns": [
    {
      "id": "11e8901b64b1ca0b9c300d1ad3125a48"
    }
  ],
  "goals": [
    {
      "id": "11e8902c79c4ee348fe5cf0da3dac545"
    }
  ]
}

POST /consumers/{consumerId}/care-plans

Creates a care plan.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
201	Created	Create a Care Plan	CarePlan
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 care plan.

Plan Migrations

Plan migrations allow for the migration of data to be completed for consumers and encounters. If a migration is made in error, users have the ability to revert a migration and return previously migrated data to its original state. After a migration is complete, both consumers and encounters will be left intact and the secondary consumer or encounter will be deactivated along with all migrated data in order to facilitate the reversion of a migration.

Retrieve a Single Data Migration Reversion Job by Encounter


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/plan-migrations/consumers/{consumerId}/encounters/reverts/{revertDataMigrationByEncounterId}', headers: headers)

print JSON.pretty_generate(result)


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

{
  "id": "70aefea8-0571-4542-8c92-2692be840388",
  "status": "IN_PROGRESS",
  "createdBy": {
    "type": "PERSONNEL",
    "reference": {
      "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
    }
  },
  "createdAt": "2018-07-25T17:03:14.120Z",
  "carePlan": {
    "description": "Diabetes Care Plan",
    "type": "VISIT",
    "status": "ACTIVE"
  },
  "report": {
    "items": [
      {
        "type": "HEALTH_CONCERN",
        "id": "11e8902c79c4ee348fe5cf0da3dac545",
        "definitionId": "11e8901b64b1ca0b9c300d1ad3125a44",
        "status": "SUCCESS"
      },
      {
        "type": "ACTIVITY",
        "id": "11e8902c79c4ee348fe5cf0da3dac545",
        "definitionId": "11e8901b64b1ca0b9c300d1ad3125a44",
        "status": "SUCCESS"
      },
      {
        "type": "GOAL",
        "id": "11e8902c79c4ee348fe5cf0da3dac545",
        "definitionId": "11e8901b64b1ca0b9c300d1ad3125a44",
        "status": "FAILED",
        "error": {
          "code": 400,
          "message": "Bad Request",
          "errorDetails": [
            {
              "message": "Status cannot be null.",
              "location": "template.healthConcernDefinitions[0][status]"
            }
          ]
        }
      },
      {
        "type": "RELATIONSHIP",
        "from": {
          "id": "11e8902c79c4ee348fe5cf0da3dac546",
          "definitionId": "11e8902c79c4ee348fe5cf0da3dac545",
          "type": "GOAL"
        },
        "to": {
          "id": "11e8902c79c4ee348fe5cf0da3dac547",
          "definitionId": "11e8901b64b1ca0b9c300d1ad3125a48",
          "type": "ACTIVITY"
        },
        "status": "FAILED",
        "error": {
          "code": 400,
          "message": "Bad Request",
          "errorDetails": [
            {
              "message": "Status cannot be null.",
              "location": "template.healthConcernDefinitions[0][status]"
            }
          ]
        }
      }
    ]
  }
}

GET /plan-migrations/consumers/{consumerId}/encounters/reverts/{revertDataMigrationByEncounterId}

Retrieves a single data migration reversion job by encounter that includes the status of the reversion job as well as a list of all items being reverted and their reversion status.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
200	OK	Retrieve a Single Data Migration Reversion Job by Encounter	Job
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 encounter data migration to revert.

Create a Job to Revert an Encounter Data Migration




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/plan-migrations/consumers/{consumerId}/encounters/reverts', headers: headers, body: {"encounters":[{"primaryEncounterId":"7e95dc60-ab92-11ec-b909-0242ac120002","secondaryEncounterId":"8d730172-ab92-11ec-b909-0242ac120002","dataPartitionId":"dc7fe1a4-ac5f-4a15-b529-e81f86f05c16"}],"createdBy":{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/plan-migrations/consumers/{consumerId}/encounters/reverts \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"encounters":[{"primaryEncounterId":"7e95dc60-ab92-11ec-b909-0242ac120002","secondaryEncounterId":"8d730172-ab92-11ec-b909-0242ac120002","dataPartitionId":"dc7fe1a4-ac5f-4a15-b529-e81f86f05c16"}],"createdBy":{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}}}

POST /plan-migrations/consumers/{consumerId}/encounters/reverts

Creates an asynchronous job to revert a previous data migration between encounters. Reverted data will be returned to its previous state on the original secondary encounter for a given encounter data migration.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
202	Accepted	Create a Job to Revert an Encounter Data Migration	Job
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Retrieve a Single Data Migration Reversion Job by Consumer


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

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

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

print JSON.pretty_generate(result)


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

{
  "id": "70aefea8-0571-4542-8c92-2692be840388",
  "status": "IN_PROGRESS",
  "createdBy": {
    "type": "PERSONNEL",
    "reference": {
      "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
    }
  },
  "createdAt": "2018-07-25T17:03:14.120Z",
  "carePlan": {
    "description": "Diabetes Care Plan",
    "type": "VISIT",
    "status": "ACTIVE"
  },
  "report": {
    "items": [
      {
        "type": "HEALTH_CONCERN",
        "id": "11e8902c79c4ee348fe5cf0da3dac545",
        "definitionId": "11e8901b64b1ca0b9c300d1ad3125a44",
        "status": "SUCCESS"
      },
      {
        "type": "ACTIVITY",
        "id": "11e8902c79c4ee348fe5cf0da3dac545",
        "definitionId": "11e8901b64b1ca0b9c300d1ad3125a44",
        "status": "SUCCESS"
      },
      {
        "type": "GOAL",
        "id": "11e8902c79c4ee348fe5cf0da3dac545",
        "definitionId": "11e8901b64b1ca0b9c300d1ad3125a44",
        "status": "FAILED",
        "error": {
          "code": 400,
          "message": "Bad Request",
          "errorDetails": [
            {
              "message": "Status cannot be null.",
              "location": "template.healthConcernDefinitions[0][status]"
            }
          ]
        }
      },
      {
        "type": "RELATIONSHIP",
        "from": {
          "id": "11e8902c79c4ee348fe5cf0da3dac546",
          "definitionId": "11e8902c79c4ee348fe5cf0da3dac545",
          "type": "GOAL"
        },
        "to": {
          "id": "11e8902c79c4ee348fe5cf0da3dac547",
          "definitionId": "11e8901b64b1ca0b9c300d1ad3125a48",
          "type": "ACTIVITY"
        },
        "status": "FAILED",
        "error": {
          "code": 400,
          "message": "Bad Request",
          "errorDetails": [
            {
              "message": "Status cannot be null.",
              "location": "template.healthConcernDefinitions[0][status]"
            }
          ]
        }
      }
    ]
  }
}

GET /plan-migrations/consumers/reverts/{revertDataMigrationByConsumerId}

Retrieves a single data migration reversion job by consumer that includes the status of the reversion job as well as a list of all items being reverted and their reversion status.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
200	OK	Retrieve a Single Data Migration Reversion Job by Consumer	Job
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 consumer data migration to revert.

Create a Job to Revert a Consumer Data Migration




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/plan-migrations/consumers/reverts', headers: headers, body: {"consumers":[{"primaryConsumerId":"7e95dc60-ab92-11ec-b909-0242ac120002","secondaryConsumerId":"8d730172-ab92-11ec-b909-0242ac120002"}],"createdBy":{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/plan-migrations/consumers/reverts \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"consumers":[{"primaryConsumerId":"7e95dc60-ab92-11ec-b909-0242ac120002","secondaryConsumerId":"8d730172-ab92-11ec-b909-0242ac120002"}],"createdBy":{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}}}

POST /plan-migrations/consumers/reverts

Creates an asynchronous job to revert a previous data migration between consumers. Reverted data will be returned to its previous state on the original secondary consumer for a given consumer data migration.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
202	Accepted	Create a Job to Revert a Consumer Data Migration	Job
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Retrieve a Single Migrate Data by Encounter Job


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/plan-migrations/consumers/{consumerId}/encounters/migrations/{id}', headers: headers)

print JSON.pretty_generate(result)


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

{
  "id": "70aefea8-0571-4542-8c92-2692be840388",
  "status": "IN_PROGRESS",
  "createdBy": {
    "type": "PERSONNEL",
    "reference": {
      "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
    }
  },
  "createdAt": "2018-07-25T17:03:14.120Z",
  "carePlan": {
    "description": "Diabetes Care Plan",
    "type": "VISIT",
    "status": "ACTIVE"
  },
  "report": {
    "items": [
      {
        "type": "HEALTH_CONCERN",
        "id": "11e8902c79c4ee348fe5cf0da3dac545",
        "definitionId": "11e8901b64b1ca0b9c300d1ad3125a44",
        "status": "SUCCESS"
      },
      {
        "type": "ACTIVITY",
        "id": "11e8902c79c4ee348fe5cf0da3dac545",
        "definitionId": "11e8901b64b1ca0b9c300d1ad3125a44",
        "status": "SUCCESS"
      },
      {
        "type": "GOAL",
        "id": "11e8902c79c4ee348fe5cf0da3dac545",
        "definitionId": "11e8901b64b1ca0b9c300d1ad3125a44",
        "status": "FAILED",
        "error": {
          "code": 400,
          "message": "Bad Request",
          "errorDetails": [
            {
              "message": "Status cannot be null.",
              "location": "template.healthConcernDefinitions[0][status]"
            }
          ]
        }
      },
      {
        "type": "RELATIONSHIP",
        "from": {
          "id": "11e8902c79c4ee348fe5cf0da3dac546",
          "definitionId": "11e8902c79c4ee348fe5cf0da3dac545",
          "type": "GOAL"
        },
        "to": {
          "id": "11e8902c79c4ee348fe5cf0da3dac547",
          "definitionId": "11e8901b64b1ca0b9c300d1ad3125a48",
          "type": "ACTIVITY"
        },
        "status": "FAILED",
        "error": {
          "code": 400,
          "message": "Bad Request",
          "errorDetails": [
            {
              "message": "Status cannot be null.",
              "location": "template.healthConcernDefinitions[0][status]"
            }
          ]
        }
      }
    ]
  }
}

GET /plan-migrations/consumers/{consumerId}/encounters/migrations/{id}

Retrieves a single migrate data by encounter job that includes the status of the migration job as well as a list of all items being migrated and their migration status.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The ID of the migration job.	-
consumerId	path	integer(int32)	true	N/A	No description	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	Retrieve a Single Migrate Data by Encounter Job	Job
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 encounter migration.

Create a Job to Migrate Data by Encounter




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/plan-migrations/consumers/{consumerId}/encounters/migrations', headers: headers, body: {"encounters":[{"primaryEncounterId":"7e95dc60-ab92-11ec-b909-0242ac120002","secondaryEncounterId":"8d730172-ab92-11ec-b909-0242ac120002","dataPartitionId":"4de3a1ab-5783-4e30-ba60-551ab1cf86fc"}],"createdBy":{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/plan-migrations/consumers/{consumerId}/encounters/migrations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"encounters":[{"primaryEncounterId":"7e95dc60-ab92-11ec-b909-0242ac120002","secondaryEncounterId":"8d730172-ab92-11ec-b909-0242ac120002","dataPartitionId":"4de3a1ab-5783-4e30-ba60-551ab1cf86fc"}],"createdBy":{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}}}

POST /plan-migrations/consumers/{consumerId}/encounters/migrations

Creates an asynchronous job to start migrating Longitudinal Plan data between given encounters. Any new Longitudinal Plan data on the secondary encounter that was not previously migrated will be migrated to the primary encounter. The Longitudinal Plan data on the secondary encounter will be updated to an Inactive status.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
202	Accepted	Create a Job to Migrate Data by Encounter	Job
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Retrieve a Single Migrate Data by Consumer Job


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

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

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

print JSON.pretty_generate(result)


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

{
  "id": "70aefea8-0571-4542-8c92-2692be840388",
  "status": "IN_PROGRESS",
  "createdBy": {
    "type": "PERSONNEL",
    "reference": {
      "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
    }
  },
  "createdAt": "2018-07-25T17:03:14.120Z",
  "carePlan": {
    "description": "Diabetes Care Plan",
    "type": "VISIT",
    "status": "ACTIVE"
  },
  "report": {
    "items": [
      {
        "type": "HEALTH_CONCERN",
        "id": "11e8902c79c4ee348fe5cf0da3dac545",
        "definitionId": "11e8901b64b1ca0b9c300d1ad3125a44",
        "status": "SUCCESS"
      },
      {
        "type": "ACTIVITY",
        "id": "11e8902c79c4ee348fe5cf0da3dac545",
        "definitionId": "11e8901b64b1ca0b9c300d1ad3125a44",
        "status": "SUCCESS"
      },
      {
        "type": "GOAL",
        "id": "11e8902c79c4ee348fe5cf0da3dac545",
        "definitionId": "11e8901b64b1ca0b9c300d1ad3125a44",
        "status": "FAILED",
        "error": {
          "code": 400,
          "message": "Bad Request",
          "errorDetails": [
            {
              "message": "Status cannot be null.",
              "location": "template.healthConcernDefinitions[0][status]"
            }
          ]
        }
      },
      {
        "type": "RELATIONSHIP",
        "from": {
          "id": "11e8902c79c4ee348fe5cf0da3dac546",
          "definitionId": "11e8902c79c4ee348fe5cf0da3dac545",
          "type": "GOAL"
        },
        "to": {
          "id": "11e8902c79c4ee348fe5cf0da3dac547",
          "definitionId": "11e8901b64b1ca0b9c300d1ad3125a48",
          "type": "ACTIVITY"
        },
        "status": "FAILED",
        "error": {
          "code": 400,
          "message": "Bad Request",
          "errorDetails": [
            {
              "message": "Status cannot be null.",
              "location": "template.healthConcernDefinitions[0][status]"
            }
          ]
        }
      }
    ]
  }
}

GET /plan-migrations/consumers/migrations/{id}

Retrieves a single migrate data by consumer job that includes the status of the migration job as well as a list of all items being migrated and their migration status.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
200	OK	Retrieve a Single Migrate Data by Consumer Job	Job
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 consumer migration.

Create a Job to Migrate Data by Consumer




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/plan-migrations/consumers/migrations', headers: headers, body: {"consumers":[{"primaryConsumerId":"7e95dc60-ab92-11ec-b909-0242ac120002","secondaryConsumerId":"8d730172-ab92-11ec-b909-0242ac120002"}],"createdBy":{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/plan-migrations/consumers/migrations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"consumers":[{"primaryConsumerId":"7e95dc60-ab92-11ec-b909-0242ac120002","secondaryConsumerId":"8d730172-ab92-11ec-b909-0242ac120002"}],"createdBy":{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}}}

POST /plan-migrations/consumers/migrations

Creates an asynchronous job to start migrating Longitudinal Plan data between given consumers. Any new Longitudinal Plan data on the secondary consumer that was not previously migrated will be migrated to the primary consumer. The Longitudinal Plan data on the secondary consumer will be updated to an Inactive status.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
202	Accepted	Create a Job to Migrate Data by Consumer	Job
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Plan Extracts

Plan Extracts allow for longitudinal plan data to be exported by consumer. After an extract has been created and is completed successfully it can be made available for download from an Amazon Web Services (AWS) Simple Storage Service (S3) bucket through the outputs endpoint.

Retrieve a List of Extract Jobs


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

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

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

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "70aefea8-0571-4542-8c92-2692be840388",
      "status": "IN_PROGRESS",
      "createdBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "createdAt": "2018-07-25T17:03:14.120Z",
      "expiresAt": "2018-07-25T17:03:14.120Z",
      "consumers": [
        {
          "id": "fb10d814-385f-48ef-a90b-302389091921"
        },
        {
          "id": "8b1361ea-c239-4867-8224-24a6fc2d1895"
        }
      ],
      "report": {
        "items": [
          {
            "type": "HEALTH_CONCERN",
            "id": "11e8902c79c4ee348fe5cf0da3dac545",
            "definitionId": "11e8901b64b1ca0b9c300d1ad3125a44",
            "status": "SUCCESS"
          },
          {
            "type": "ACTIVITY",
            "id": "11e8902c79c4ee348fe5cf0da3dac545",
            "definitionId": "11e8901b64b1ca0b9c300d1ad3125a44",
            "status": "SUCCESS"
          },
          {
            "type": "GOAL",
            "id": "11e8902c79c4ee348fe5cf0da3dac545",
            "definitionId": "11e8901b64b1ca0b9c300d1ad3125a44",
            "status": "FAILED",
            "error": {
              "code": 400,
              "message": "Bad Request",
              "errorDetails": [
                {
                  "message": "Status cannot be null.",
                  "location": "template.healthConcernDefinitions[0][status]"
                }
              ]
            }
          },
          {
            "type": "RELATIONSHIP",
            "from": {
              "id": "11e8902c79c4ee348fe5cf0da3dac546",
              "definitionId": "11e8902c79c4ee348fe5cf0da3dac545",
              "type": "GOAL"
            },
            "to": {
              "id": "11e8902c79c4ee348fe5cf0da3dac547",
              "definitionId": "11e8901b64b1ca0b9c300d1ad3125a48",
              "type": "ACTIVITY"
            },
            "status": "FAILED",
            "error": {
              "code": 400,
              "message": "Bad Request",
              "errorDetails": [
                {
                  "message": "Status cannot be null.",
                  "location": "template.healthConcernDefinitions[0][status]"
                }
              ]
            }
          }
        ]
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/extracts?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/extracts?offset=0&limit=20"
}

GET /extracts

Returns a list of information about the requested extraction jobs which can be filtered by status, consumers, or both and return paginated results. Information includes the ID of each consumer being extracted as well as the job status.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
status	query	array[string]	false	N/A	Filters the retrieved extract by status.	IN_PROGRESS, COMPLETE, IN_ERROR, ARCHIVED
consumerId	query	array[string]	false	N/A	Filters the retrieved extract by consumer ID.	-
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 Extract Jobs	Extracts
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Create an Extract Job




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/extracts', headers: headers, body: {"consumers":[{"id":"fb10d814-385f-48ef-a90b-302389091921"},{"id":"8b1361ea-c239-4867-8224-24a6fc2d1895"}],"createdBy":{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/extracts \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"consumers":[{"id":"fb10d814-385f-48ef-a90b-302389091921"},{"id":"8b1361ea-c239-4867-8224-24a6fc2d1895"}],"createdBy":{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}}}

POST /extracts

Creates an extraction job that will extract all longitudinal plan data for the given list of consumers, making data available for output.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
202	Accepted	Create an Extract Job	Extract
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Retrieve a Single Extract Job


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/extracts/327a1354-de2b-43fe-a966-338d6146bc6c', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/longitudinal-plan/v1/extracts/327a1354-de2b-43fe-a966-338d6146bc6c \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "70aefea8-0571-4542-8c92-2692be840388",
  "status": "IN_PROGRESS",
  "createdBy": {
    "type": "PERSONNEL",
    "reference": {
      "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
    }
  },
  "createdAt": "2018-07-25T17:03:14.120Z",
  "expiresAt": "2018-07-25T17:03:14.120Z",
  "consumers": [
    {
      "id": "fb10d814-385f-48ef-a90b-302389091921"
    },
    {
      "id": "8b1361ea-c239-4867-8224-24a6fc2d1895"
    }
  ],
  "report": {
    "items": [
      {
        "type": "HEALTH_CONCERN",
        "id": "11e8902c79c4ee348fe5cf0da3dac545",
        "definitionId": "11e8901b64b1ca0b9c300d1ad3125a44",
        "status": "SUCCESS"
      },
      {
        "type": "ACTIVITY",
        "id": "11e8902c79c4ee348fe5cf0da3dac545",
        "definitionId": "11e8901b64b1ca0b9c300d1ad3125a44",
        "status": "SUCCESS"
      },
      {
        "type": "GOAL",
        "id": "11e8902c79c4ee348fe5cf0da3dac545",
        "definitionId": "11e8901b64b1ca0b9c300d1ad3125a44",
        "status": "FAILED",
        "error": {
          "code": 400,
          "message": "Bad Request",
          "errorDetails": [
            {
              "message": "Status cannot be null.",
              "location": "template.healthConcernDefinitions[0][status]"
            }
          ]
        }
      },
      {
        "type": "RELATIONSHIP",
        "from": {
          "id": "11e8902c79c4ee348fe5cf0da3dac546",
          "definitionId": "11e8902c79c4ee348fe5cf0da3dac545",
          "type": "GOAL"
        },
        "to": {
          "id": "11e8902c79c4ee348fe5cf0da3dac547",
          "definitionId": "11e8901b64b1ca0b9c300d1ad3125a48",
          "type": "ACTIVITY"
        },
        "status": "FAILED",
        "error": {
          "code": 400,
          "message": "Bad Request",
          "errorDetails": [
            {
              "message": "Status cannot be null.",
              "location": "template.healthConcernDefinitions[0][status]"
            }
          ]
        }
      }
    ]
  }
}

GET /extracts/{id}

Returns information about a single extract job using the job ID. Information includes the ID of each consumer being extracted as well as the job status.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
200	OK	Retrieve a Single Extract Job	Job
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 extraction.

Retrieve a Single S3 Output


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

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

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

print JSON.pretty_generate(result)


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

{
  "type": "HEALTH_CONCERNS",
  "createdAt": "2018-07-25T17:03:14.120Z",
  "expiresAt": "2018-07-25T17:03:14.120Z"
}

GET /extracts/{extract_id}/outputs/{id}

Returns information about a single output using its ID. Information includes the ID of each output, the type of output, and a pre-signed S3 URL in the Content-Location header.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The ID of the output.	-
extract_id	path	string	true	N/A	The ID of the extract.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	Retrieve a Single S3 Output	Output
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 output.

Retrieve a List of S3 Outputs


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

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

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

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "type": "HEALTH_CONCERNS",
      "createdAt": "2018-07-25T17:03:14.120Z",
      "expiresAt": "2018-07-25T17:03:14.120Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/example/v1/examples?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/example/v1/examples?offset=0&limit=20"
}

GET /extracts/{extract_id}/outputs

Returns a list of outputs for the given extract ID, which can be filtered by type and return paginated results. Information includes the ID of each output as well as the type of output.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
type	query	array[string]	false	N/A	Filters outputs by type.	GOALS, HEALTH_CONCERNS, ACTIVITIES, STRENGTHS, CARE_PLANS
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.	-
extract_id	path	integer(int32)	true	N/A	No description	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	Retrieve a List of S3 Outputs	Outputs
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 output.

Schema Definitions

ActivityDefinition

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the activity definition.	-
text	string	true	The short textual description of the activity definition.	-
status	string	true	The current status of the activity definition. The following statuses are possible: - ACTIVE: Indicates that the definition can be used when adding the resource to the plan. - INACTIVE: Indicates that the definition cannot be used when adding the resource to the plan.	ACTIVE, INACTIVE
categories	[Category]	false	A list of category objects.	-
disciplines	[Discipline]	false	A list of discipline objects.	-
coding	[Coding]	false	A list of coding objects.	-
description	string	false	The detailed description of the activity definition.	-
instantiatesUrl	string	false	The URL pointing to an externally maintained activity definition.	-
targets	[TargetDefinition]	false	Targets can be used to measure goals and activities for completion, compliance, and progress. They can be Boolean values, numeric values, or ranges of high to low values.	-
targetGroups	[TargetGroupDefinition]	false	Used instead of targets field to group targets. A group can have a name or be unnamed. Sequencing is maintained by the natural order and applicable for both “targetGroups” and “targets” levels.	-
supportingExternalReferences	[SupportingExternalReference]	false	References to items that exist outside of Health Data Intelligence 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 Health Data Intelligence and would support the progression orcompletion of the activity.	-

Coding

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

Discipline

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

TargetDefinition

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

TargetMeasureType

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

TargetDetailDefinition

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

TargetBoolean

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

TargetNumericDefinition

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

TargetUnitDefinition

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

TargetRangeDefinition

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

TargetGroupDefinition

Name	Type	Required	Description	Accepted Values
name	string	false	Group name.	-
targets	[TargetDefinition]	true	Targets list	-

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 Health Data Intelligence.	-

ActivityDefinitionTemplate

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

ActivityDefinitionTemplateSingle

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.	-
status	string	false	The current status of the activity definition.	ACTIVE, INACTIVE

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.	-
targetGroups	[TargetGroupDefinition]	false	Used instead of targets field to group targets. A group can have a name or be unnamed. Sequencing is maintained by the natural order and applicable for both targetGroups and targets levels. Both targets and targetGroups should not be filled in the same request body.	-

GoalDefinitionTemplate

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

ShortTermGoalDefinitionTemplate

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

HealthConcernDefinitionTemplate

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

GoalDefinitionTemplateSingle

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the goal definition.	-
text	string	false	The display text of the goal definition.	-
status	string	false	The current status of the goal definition.	ACTIVE, INACTIVE
activityDefinitions	[ActivityDefinitionTemplateSingle]	false	The activity definitions representing the activities that support this goal in the context of this plan template.	-
shortTermGoalDefinitions	[ShortTermGoalDefinitionTemplateSingle]	false	The short-term goal definitions representing the short-term goals that support the long-term goal in the context of this plan template.	-

ShortTermGoalDefinitionTemplateSingle

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the goal definition.	-
text	string	false	The display text of the goal definition.	-
status	string	false	The current status of the goal definition.	ACTIVE, INACTIVE
activityDefinitions	[ActivityDefinitionTemplateSingle]	false	The activity definitions representing the activities that support this goal in the context of this plan template.	-

HealthConcernDefinitionTemplateSingle

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the health concern definition.	-
text	string	false	The display text of the health concern definition.	-
status	string	false	The current status of the health concern definition.	ACTIVE, INACTIVE
goalDefinitions	[GoalDefinitionTemplateSingle]	false	The goal definitions representing the goals that support this health concern in the context of this plan template.	-
activityDefinitions	[ActivityDefinitionTemplateSingle]	false	The activity definitions representing the activities that support this health concern in the context of this plan template.	-

PlanTemplate

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

PlanTemplateSingle

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

StrengthDefinition

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the strength definition.	-
text	string	true	A textual description of the strength definition.	-
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.	-

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

Strength

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the strength.	-
consumer	Reference	true	The ID of the Health Data Intelligence 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.	-
originatingSourceEncounter	OriginatingSourceEncounter	false	The encounter at which the care plan item is created. Encounters are interactions between a patient and a provider for the purpose of providing care.	-
updatedSourceEncounter	UpdatedSourceEncounter	false	The encounter at which the care plan item is updated. Encounters are interactions between a patient and a provider for the purpose of providing care.	-
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.	-

OriginatingSourceEncounter

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the encounter for a patient in a data partition.	-
dataPartitionId	string	true	The Health Data Intelligence data partition ID of the data source.	-

UpdatedSourceEncounter

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the encounter for a patient in a data partition.	-
dataPartitionId	string	true	The Health Data Intelligence data partition ID of the data source.	-

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

MeasureSuggestionDefinition

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the measure suggestion definition.	-
population	Population	true	The population that is referenced for the measure suggestion definition.	-
program	Program	true	The program that is referenced for the measure suggestion definition.	-
status	string	true	Indicates the current state of the measure suggestion definition. Currently, the following statuses are possible: `ACTIVE`: Indicates that the measure suggestion definition is active. `INACTIVE`: Indicates that the measure suggestion definition is not active.	ACTIVE, INACTIVE
planDefinition	PlanDefinition	true	The plan definition that is referenced for the measure suggestion definition.	-
planEntity	PlanEntity	true	The plan entity that is referenced for the measure suggestion definition.	-
programGroup	ProgramGroup	false	The program group that is referenced for the measure suggestion definition.	-
createdAt	string	true	The date and time when the measure suggestion 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 measure suggestion definition is first created.	-
updatedAt	string	true	The date and time when the measure suggestion 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 measure suggestion definition is modified; therefore, the field does not need to be set explicitly. When the measure suggestion definition is first created, the value in the `updatedAt` field is set by the service to match the value in the `createdAt` field.	-
version	integer(int32)	true	The current version of measure suggestion definition. The version value needs to be sent as If-Match header value for updating the resource.	-

Population

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the population.	-

Program

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the program associated with the program suggestion.	-
measure	Measure	true	The measure that is referenced for the program.	-

Measure

Name Type Required Description Accepted Values

id string true The unique ID of the measure. -

outcome

string

true

Indicates the current state of the measure. Currently, the following outcomes are possible:

NOT_ACHIEVED: Indicates that the measure is not successfully achieved.
MISSING_DATA: Indicates that the measure is missing some data.
ACHIEVED: Indicates that the measure is successfully achieved.
EXCLUDED: Indicates that the measure is excluded.

NOT_ACHIEVED, MISSING_DATA, ACHIEVED, EXCLUDED

PlanDefinition

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the plan definition.	-
type	string	true	Indicates the type of plan definition. Currently, only `ACTIVITY_DEFINITION` is possible. `ACTIVITY_DEFINITION` indicates that an activity definition acts as a template that can be referenced when creating an activity.	ACTIVITY_DEFINITION

PlanEntity

Name Type Required Description Accepted Values

action

string

true

Indicates the type of action that should be performed. Currently, the following actions are possible:

CREATE: Indicates that a new entity should be created with the type specified in planDefinition.
UPDATE: Indicates that the planEntity should be updated.

CREATE, UPDATE

activity PlanEntityActivity true The activity that is referenced for the PlanEntity. -

PlanEntityActivity

Name Type Required Description Accepted Values

status

string

true

Indicates the status. Currently, the following statuses are possible:

PROPOSED
ACCEPTED
COMPLETED
CANCELLED

PROPOSED, ACCEPTED, COMPLETED, CANCELLED

ProgramGroup

Name	Type	Required	Description	Accepted Values
id	string	false	The unique ID of the program group.	-

BarrierDefinition

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the barrier.	-
version	integer(int32)	true	The current version of the barrier. 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 current status of the barrier 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.	INACTIVE, ACTIVE
code	BarrierCodeableConcept	true	Describes the barrier definition. Includes a text description of the barrier and possibly a set of codings.	-
concept	Concept	false	The most applicable concept to use for coding purposes when instantiating the defined barrier definition. Or, for searching purposes, the set of codes that are most applicable.	-
createdAt	string	true	The ISO 8601 date and time when the barrier definition 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 in this field is set automatically when the barrier definition is first created. Therefore, the field does not need to be set explicitly.	-
updatedAt	string	true	The ISO 8601 date and time when the barrier definition 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 barrier definition 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.	-

BarrierCodeableConcept

Name	Type	Required	Description	Accepted Values
text	string	true	A human-readable, potentially personalized description of the barrier. This field must be provided for every barrier.	-
codings	[Code]	false	A list of codified values from a standard code system.	-

Code

Name	Type	Required	Description	Accepted Values
code	string	true	The unique ID of the code.	-
system	string	true	The ID of the coding system that gives meaning to the code.	-

Concept

Name	Type	Required	Description	Accepted Values
contextId	string	true	The unique context ID defined in the ontology.	-
conceptAlias	string	true	The text mnemonic defined in the ontology that identifies the concept in the context.	-

Barrier

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the barrier.	-
status	string	true	Indicates the current state of the barrier. Currently, the following statuses are possible: - INACTIVE: Indicates that the barrier no longer exists. - ACTIVE: Indicates that the barrier is currently evident.	INACTIVE, ACTIVE
version	integer(int32)	true	The current version of the barrier. 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.	-
barrierDefinition	BarrierDefinitionReference	false	The barrier definition that was referenced when the barrier was first created. This field is immutable and can be set only when the barrier is initially created.	-
code	BarrierCodeableConcept	true	Describes the barrier. Includes a text description of the barrier and possibly a set of codings.	-
concept	Concept	false	The most applicable concept to use for coding purposes when instantiating the defined barrier. Or, for searching purposes, the set of codes that are most applicable.	-
createdAt	string	true	The ISO 8601 date and time when the barrier 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 in this field is set automatically when the barrier is first created. Therefore, the field does not need to be set explicitly.	-
createdBy	Actor	true	The individual who entered the barrier into the system.	-
updatedAt	string	true	The ISO 8601 date and time when the barrier 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 barrier is modified. Therefore, the field does not need to be set explicitly. When the barrier is first created, the updatedAt value is set by the service and matches the createdAt field.	-
updatedBy	Actor	true	A representation of the individual who last modified the barrier in the system. When the barrier is first created, the value in ‘updatedBy’ is set by the service and matches the ‘createdBy’ field.	-

BarrierDefinitionReference

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the barrier definition.	-
text	string	true	The text description of the barrier 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), a professional in the tenant’s organization (PERSONNEL), or a consumer (SUBJECT). See the following definitions: - SUBJECT: The individual is the consumer. When the type is SUBJECT, display, reference and ID are not required. - SYSTEM: - SYSTEM is used to identify a nonliving 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, SUBJECT
reference	Reference	false	A reference to the individual.	-
display	string	false	A text display that describes the referenced entity.	-

ActivityBrief

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the activity.	-
description	string	true	The text description of the activity. \ The value in this field likely is personalized to the individual when the activity originates from an 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 not begun. - IN_PROGRESS: Indicates that the activity began 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 is scheduled but has not 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
supportingExternalReferences	[SupportingExternalReference]	false	References to items that exist outside of Health Data Intelligence and support the progression or completion of the activity. Note that an external supporting reference does not provide all the information required for a system that uses this API to locate and retrieve the item referenced. Systems that use an external supporting reference need prior knowledge and coordination with the system that contains the external supporting reference to understand how to retrieve the information about the item referenced.	-
supportingReferences	[SupportingReference]	false	References to items that exist in Health Data Intelligence and support the progression or completion of the activity.	-
createdAt	string	true	The ISO 8601 date and 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 in this field is set automatically when the activity is first created. Therefore, the field does not need to be set explicitly.	-

ConsumerActivity

Name	Type	Required	Description	Accepted Values
consumer	Reference	true	The consumer with which activities are associated.	-
activities	[ActivityBrief]	true	A list of activities.	-

MeasureSuggestionSet

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the measure suggestion set.	-
name	string	true	The name of the measure suggestion set.	-
patients	[PatientReference]	false	Patients associated with a measure suggestion set.	-
status	string	true	The current status of measure suggestion set. 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.	INACTIVE, ACTIVE
updatedAt	string	true	The ISO 8601 date and time when measure suggestion set 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 measure suggestion set is modified. Therefore, the field does not need to be set explicitly. When measure suggestion set is first created, the updatedAt value is set by the service and matches the createdAt field.	-
createdAt	string	true	The ISO 8601 date and time when measure suggestion set 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 in this field is set automatically when measure suggestion set is first created. Therefore, the field does not need to be set explicitly.	-
version	integer(int32)	true	The current version of measure suggestion set. The version value needs to be sent as If-Match header value for updating the resource.	-

PatientReference

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the Health Data Intelligence patient. See Patient ID lookup for more information	-

CarePlan

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the longitudinal care plan.	-
consumer	Reference	true	The consumer with which care plan is associated.	-
description	string	true	A textual description of the care plan. The maximum length is 1000 characters.	-
type	string	true	The type of the care plan. The following types are possible: - VISIT: Indicates that the plan is associated with a specific encounter. - ONGOING: Indicates that the plan is for an ongoing or chronic concern or condition and not specific to a single encounter.	VISIT, ONGOING
status	string	true	The current status of the care plan. The following statuses are possible: - ACTIVE: Indicates that the plan is currently in effect and being acted upon for the consumer. - INACTIVE: Indicates that the plan is not currently in effect for the consumer. - COMPLETED: Indicates that the plan is in a final state of completion. - REJECTED: Indicates that the plan is rejected. - IN_ERROR: Indicates that the plan was mistakenly identified. - SUSPENDED: Indicates that the plan is on hold.	IN_ERROR, COMPLETED, ACTIVE, REJECTED, SUSPENDED, INACTIVE
version	integer(int32)	true	The current version of the care plan.	-
progress	string	false	The progress towards the care plan. The following progresses are possible: - PROGRESSING: Indicates that the patient/consumer is progressing towards the care plan goals or is doing better than before. - REGRESSING: Indicates that the patient/consumer is doing worse than before. - AT_TARGET: Indicates that the patient/consumer is currently meeting the care plan goals and will continue to work toward maintaining them. - ACHIEVED: Indicates that the patient/consumer met the care plan goals. - NOT_ACHIEVED: Indicates that the patient/consumer did not meet the care plan goals.	PROGRESSING, REGRESSING, AT_TARGET, ACHIEVED, NOT_ACHIEVED
priority	string	false	The priority of the care plan. The following priorities are possible: - HIGH: Indicates that the priority is high. - MEDIUM: Indicates that the priority is medium. - LOW: Indicates that the priority is low.	HIGH, MEDIUM, LOW
originatingSourceEncounter	OriginatingSourceEncounter	false	The encounter at which the care plan item is created. Encounters are interactions between a patient and a provider for the purpose of providing care.	-
updatedSourceEncounter	UpdatedSourceEncounter	false	The encounter at which the care plan item is updated. Encounters are interactions between a patient and a provider for the purpose of providing care.	-
createdAt	string	true	The date and time when the care plan 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.	-
createdBy	Actor	true	The individual who entered the care plan into the system.	-
updatedAt	string	true	The date and time when the care plan 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.	-
updatedBy	Actor	true	The individual who updated the care plan in the system.	-
healthConcerns	[CarePlanHealthConcern]	false	The health concerns that are contained in this care plan.	-
goals	[GoalSummary]	false	The goals that are contained in this care plan.	-

CarePlanHealthConcern

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the health concern.	-
status	string	true	The current status of the health concern. The following statuses are possible: - ACCEPTED: Indicates that the health concern was accepted or acknowledged. - ACTIVE: Indicates that signs or symptoms of the health concern are currently evident. - IN_ERROR: Indicates that the health concern was mistakenly identified. - PROPOSED: Indicates that the health concern was proposed. - REJECTED: Indicates that the health concern was rejected. - RELAPSE: Indicates that signs or symptoms of the health concern have returned after a period of improvement or remission. - REMISSION: Indicates that signs or symptoms of the health concern are no longer evident but are at risk of returning. - RESOLVED: Indicates that signs or symptoms of the health concern are no longer evident. - INACTIVE: Indicates that the person is no longer experiencing symptoms of the concern or that evidence of the concern no longer exists.	-
code	CodeableConceptLite	true	Describes a health concern, for example, obesity or hypertension. Health concerns can represent traditional medical problems, risks, complaints, or symptoms as well as social concerns. Includes a textual description of the health concern and possibly a set of codings. While the textual description can be changed, the codings cannot. After the health concern is created, codings associated with it cannot be changed.	-
updatedAt	string	true	The ISO 8601 date and time when the health concern 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 health concern is modified. Therefore, the field does not need to be set explicitly. When the health concern is first created, the updatedAt value is set by the service and matches the createdAt field.	-

CodeableConceptLite

Name	Type	Required	Description	Accepted Values
text	string	true	A human-readable, potentially personalized description of the health concern. This field must be provided for every health concern.	-

GoalSummary

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the goal.	-
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
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.	-
disciplines	[DisciplineReference]	false	A list of disciplines.	-
dueDate	string	false	The ISO 8601 date when the goal should be completed.	-
updatedAt	string	true	The ISO 8601 date and 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.	-

DisciplineReference

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

HealthConcernSummary

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the health concern.	-
status	string	true	The current status of the health concern. The following statuses are possible: - ACCEPTED: Indicates that the health concern was accepted or acknowledged. - ACTIVE: Indicates that signs or symptoms of the health concern are currently evident. - IN_ERROR: Indicates that the health concern was mistakenly identified. - PROPOSED: Indicates that the health concern was proposed. - REJECTED: Indicates that the health concern was rejected. - RELAPSE: Indicates that signs or symptoms of the health concern have returned after a period of improvement or remission. - REMISSION: Indicates that signs or symptoms of the health concern are no longer evident but are at risk of returning. - RESOLVED: Indicates that signs or symptoms of the health concern are no longer evident. - INACTIVE: Indicates that the person is no longer experiencing symptoms of the concern or that evidence of the concern no longer exists.	-
code	CodeableConceptLite	true	Describes a health concern, for example, obesity or hypertension. Health concerns can represent traditional medical problems, risks, complaints, or symptoms as well as social concerns. Includes a textual description of the health concern and possibly a set of codings. While the textual description can be changed, the codings cannot. After the health concern is created, codings associated with it cannot be changed.	-
updatedAt	string	true	The ISO 8601 date and time when the health concern 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 health concern is modified. Therefore, the field does not need to be set explicitly. When the health concern is first created, the updatedAt value is set by the service and matches the createdAt field.	-
description	string	false	A textual description of the health concern. The maximum length is 1000 characters.	-

Job

Name	Type	Required	Description	Accepted Values
id	string	true	Uniquely identifies the job and retrieves the job detail.	-
status	string	true	Indicates the current state of the apply plan template job. Currently, the following statuses are possible: - IN_PROGRESS: Indicates that the job is currently being processed. - SUCCESS: Indicates that the job has been successfully processed. - FAILED: Indicates that the job totally failed or partially failed to be processed.	IN_PROGRESS, SUCCEEDED, FAILED
createdBy	Actor	true	The individual who entered the apply plan template into the system.	-
createdAt	string	true	The ISO 8601 date and time when the apply plan template 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 in this field is set automatically when the apply plan template is first created. Therefore, the field does not need to be set explicitly.	-
carePlan	CarePlan	false	The care plan contained in this plan template.	-
report	Report	true	The information that will be returned about the outcomes of the job. The report will display when the job status is SUCCEEDED or FAILED. A report consists of a list of items and total results. The report attribute will always be displayed.	-

Report

Name	Type	Required	Description	Accepted Values
items	ReportDetail	false	The list of items in the report.	-

ReportDetail

Name	Type	Required	Description	Accepted Values
id	string	false	The ID of the report item.	-
definitionId	string	false	The ID of the definition.	-
primaryId	string	false	The ID of the primary entity that was migrated or reverted to.	-
secondaryId	string	false	The ID of the secondary entity that was migrated or reverted from.	-
type	string	false	The type of the report.	HEALTH_CONCERN, GOAL, ACTIVITY, RELATIONSHIP
status	string	false	The status of the report.	SUCCESS, FAILED
error	Error	false	The information about errors if any occurred.	-
from	ReportDetail	false	The report information for RELATIONSHIP type.	-
to	ReportDetail	false	The report information for RELATIONSHIP type.	-

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

Extract

Name	Type	Required	Description	Accepted Values
id	string	true	Uniquely identifies the extraction job and retrieves the extraction detail.	-
status	string	true	Indicates the current state of the extraction job. Currently, the following statuses are possible: - IN_PROGRESS: Indicates that the job is currently being processed. - SUCCESS: Indicates that the job has been successfully processed. - FAILED: Indicates that the job totally failed or partially failed to be processed. - ARCHIVED: Indicates that the job has been archived and the outputs associated with the extraction are no longer available.	IN_PROGRESS, SUCCEEDED, FAILED, ARCHIVED
createdBy	Actor	true	The individual who entered the extraction into the system.	-
createdAt	string	true	The ISO 8601 date and time when the extraction 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 in this field is set automatically when the extraction is first created. Therefore, the field does not need to be set explicitly.	-
expiresAt	string	false	The ISO 8601 date and time when the extraction’s availability will expire. Precision is in the millisecond YYYY-MM-DDTHH:mm:ss.sssZ format, for example, 2018-02-13T20:41:18.181Z. The time in this field may be set explicitly when the extraction is first created. When the extraction expires the associated outputs will no longer be available.	-
consumers	[any]	true	The list of consumers for which all longitudinal plan data is being extracted for the given job.	-
report	Report	true	The information that will be returned about the outcomes of the job. The report will display when the job status is SUCCEEDED or FAILED. A report consists of a list of items and total results. The report attribute will always be displayed.	-

Output

Name	Type	Required	Description	Accepted Values
id	string	true	Uniquely identifies the output and retrieves the output detail.	-
type	string	true	Indicates the plan entity type of the output. The following types are possible: GOALS, HEALTH_CONCERNS, ACTIVITIES, STRENGTHS, and CARE_PLANS.	GOALS, HEALTH_CONCERNS, ACTIVITIES, STRENGTHS, CARE_PLANS
createdAt	string	true	The ISO 8601 date and time when the extraction 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 in this field is set automatically when the extraction is first created. Therefore, the field does not need to be set explicitly.	-
expiresAt	string	false	The ISO 8601 date and time when the extraction’s availability will expire. Precision is in the millisecond YYYY-MM-DDTHH:mm:ss.sssZ format, for example, 2018-02-13T20:41:18.181Z. The time in this field may be set explicitly when the extraction is first created. When the extraction expires the associated outputs will no longer be available.	-

putConsumersConsumeridCarePlans

Name	Type	Required	Description	Accepted Values
progress	string	false	The progress towards the care plan. The following progresses are possible: - PROGRESSING: Indicates that the patient/consumer is progressing towards the care plan goals or is doing better than before. - REGRESSING: Indicates that the patient/consumer is doing worse than before. - AT_TARGET: Indicates that the patient/consumer is currently meeting the care plan goals and will continue to work toward maintaining them. - ACHIEVED: Indicates that the patient/consumer met the care plan goals. - NOT_ACHIEVED: Indicates that the patient/consumer did not meet the care plan goals.	PROGRESSING, REGRESSING, AT_TARGET, ACHIEVED, NOT_ACHIEVED
priority	string	false	The priority of the care plan. The following priorities are possible: - HIGH: Indicates that the priority is high. - MEDIUM: Indicates that the priority is medium. - LOW: Indicates that the priority is low.	HIGH, MEDIUM, LOW
description	string	true	A textual description of the care plan. The maximum length is 1000 characters.	-
type	string	true	The type of the care plan. The following types are possible: - VISIT: Indicates that the plan is associated with a specific encounter. - ONGOING: Indicates that the plan is for an ongoing or chronic concern or condition and not specific to a single encounter.	VISIT, ONGOING
status	string	true	The current status of the care plan. The following statuses are possible: - ACTIVE: Indicates that the plan is currently in effect and being acted upon for the consumer. - INACTIVE: Indicates that the plan is not currently in effect for the consumer. - COMPLETED: Indicates that the plan is in a final state of completion. - REJECTED: Indicates that the plan is rejected. - IN_ERROR: Indicates that the plan was mistakenly identified. - SUSPENDED: Indicates that the plan is on hold.	IN_ERROR, COMPLETED, ACTIVE, REJECTED, SUSPENDED, INACTIVE
updatedBy	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 entity. Currently, it could be an application or algorithm (SYSTEM), a professional in the tenant’s organization (PERSONNEL), or a consumer (SUBJECT). See the following definitions: - SUBJECT: The individual is the consumer. When the type is SUBJECT, display, reference and ID are not required. - SYSTEM: - SYSTEM is used to identify a nonliving 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, SUBJECT
» display	string	false	A text 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.	-
healthConcerns	[object]	false	The health concerns that are contained in the care plan.	-
» id	string	true	The ID of the health concern.	-
goals	[object]	false	The goals that are contained in this care plan.	-
» id	string	false	The ID of the goal.	-
» status	string	false	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
» description	string	false	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.	-
» disciplines	[DisciplineReference]	false	A list of disciplines.	-
» dueDate	string	false	The ISO 8601 date when the goal should be completed.	-
» updatedAt	string	false	The ISO 8601 date and 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.	-
updatedSourceEncounter	object	false	The encounter at which the care plan item is updated. Encounters are interactions between a patient and a provider for the purpose of providing care.	-
» id	string	true	The unique ID of the encounter for a patient in a data partition.	-
» dataPartitionId	string	true	The Health Data Intelligence data partition ID of the data source.	-

CarePlans

Name	Type	Required	Description	Accepted Values
items	[CarePlan]	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.	-

postConsumersConsumeridCarePlans

Name	Type	Required	Description	Accepted Values
progress	string	false	The progress towards the care plan. The following progresses are possible: - PROGRESSING: Indicates that the patient/consumer is progressing towards the care plan goals or is doing better than before. - REGRESSING: Indicates that the patient/consumer is doing worse than before. - AT_TARGET: Indicates that the patient/consumer is currently meeting the care plan goals and will continue to work toward maintaining them. - ACHIEVED: Indicates that the patient/consumer met the care plan goals. - NOT_ACHIEVED: Indicates that the patient/consumer did not meet the care plan goals.	PROGRESSING, REGRESSING, AT_TARGET, ACHIEVED, NOT_ACHIEVED
priority	string	false	The priority of the care plan. The following priorities are possible: - HIGH: Indicates that the priority is high. - MEDIUM: Indicates that the priority is medium. - LOW: Indicates that the priority is low.	HIGH, MEDIUM, LOW
description	string	true	A textual description of the care plan. The maximum length is 1000 characters.	-
type	string	true	The type of the care plan. The following types are possible: - VISIT: Indicates that the plan is associated with a specific encounter. - ONGOING: Indicates that the plan is for an ongoing or chronic concern or condition and not specific to a single encounter.	VISIT, ONGOING
status	string	true	The current status of the care plan. The following statuses are possible: - ACTIVE: Indicates that the plan is currently in effect and being acted upon for the consumer. - INACTIVE: Indicates that the plan is not currently in effect for the consumer. - COMPLETED: Indicates that the plan is in a final state of completion. - REJECTED: Indicates that the plan is rejected. - IN_ERROR: Indicates that the plan was mistakenly identified. - SUSPENDED: Indicates that the plan is on hold.	IN_ERROR, COMPLETED, ACTIVE, REJECTED, SUSPENDED, INACTIVE
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 entity. Currently, it could be an application or algorithm (SYSTEM), a professional in the tenant’s organization (PERSONNEL), or a consumer (SUBJECT). See the following definitions: - SUBJECT: The individual is the consumer. When the type is SUBJECT, display, reference and ID are not required. - SYSTEM: - SYSTEM is used to identify a nonliving 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, SUBJECT
» display	string	false	A text 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.	-
healthConcerns	[object]	false	The health concerns that are contained in the care plan.	-
» id	string	true	The ID of the health concern.	-
goals	[object]	false	The goals that are contained in this care plan.	-
» id	string	false	The ID of the goal.	-
» status	string	false	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
» description	string	false	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.	-
» disciplines	[DisciplineReference]	false	A list of disciplines.	-
» dueDate	string	false	The ISO 8601 date when the goal should be completed.	-
» updatedAt	string	false	The ISO 8601 date and 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.	-
originatingSourceEncounter	object	false	The encounter at which the care plan item is created. Encounters are interactions between a patient and a provider for the purpose of providing care.	-
» id	string	true	The unique ID of the encounter for a patient in a data partition.	-
» dataPartitionId	string	true	The Health Data Intelligence data partition ID of the data source.	-

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

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.	-
originatingSourceEncounter	object	false	The encounter at which the care plan item is created. Encounters are interactions between a patient and a provider for the purpose of providing care.	-
» id	string	true	The unique ID of the encounter for a patient in a data partition.	-
» dataPartitionId	string	true	The Health Data Intelligence data partition ID of the data source.	-

postConsumersConsumeridApplyTemplates

Name	Type	Required	Description	Accepted Values
createdBy	object	true	A representation of the individual who entered the item into the system.	-
originatingSourceEncounter	object	false	The encounter in which the care plan item is created. Encounters are interactions between a patient and a provider for the purpose of providing care.	-
template	object	true	Apply Plan Template.	-
» id	string	true	The ID of the Longitudinal Plan Template.	-
» 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.	-
»» status	string	true	No description	IN_ERROR, ACCEPTED, ACTIVE, PROPOSED, REJECTED, RELAPSE, REMISSION, RESOLVED, INACTIVE
»» code	object	false	The optional codeable concept to be applied to the health concern.	-
»»» text	string	false	The optional text value supplied for the health concern. If empty, the text from the health concern definition is used.	-
»»» codings	[object]	false	The optional codings applied to the health concern.	-
»»»» code	string	true	No description	-
»»»» system	string	true	No description	-
»» 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.	-
»»» status	string	true	No description	NOT_STARTED, IN_PROGRESS, COMPLETED, CANCELLED, SUSPENDED, SCHEDULED, PROPOSED, ACCEPTED, REJECTED, IN_ERROR
»» 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.	-
»»» status	string	true	No description	PLANNED, IN_PROGRESS, CANCELLED, IN_ERROR, PROPOSED, ACCEPTED, REJECTED, SUSPENDED, COMPLETED
»»» 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.	-
»»»» status	string	true	No description	NOT_STARTED, IN_PROGRESS, COMPLETED, CANCELLED, SUSPENDED, SCHEDULED, PROPOSED, ACCEPTED, REJECTED, IN_ERROR
»»» 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.	-
»»»» status	string	true	No description	PLANNED, IN_PROGRESS, CANCELLED, IN_ERROR, PROPOSED, ACCEPTED, REJECTED, SUSPENDED, COMPLETED
»»»» 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.	-
»»»»» status	string	true	No description	NOT_STARTED, IN_PROGRESS, COMPLETED, CANCELLED, SUSPENDED, SCHEDULED, PROPOSED, ACCEPTED, REJECTED, IN_ERROR
» 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.	-
»» status	string	true	No description	PLANNED, IN_PROGRESS, CANCELLED, IN_ERROR, PROPOSED, ACCEPTED, REJECTED, SUSPENDED, COMPLETED
»» 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.	-
»»» status	string	true	No description	NOT_STARTED, IN_PROGRESS, COMPLETED, CANCELLED, SUSPENDED, SCHEDULED, PROPOSED, ACCEPTED, REJECTED, IN_ERROR
»» 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.	-
»»» status	string	true	No description	PLANNED, IN_PROGRESS, CANCELLED, IN_ERROR, PROPOSED, ACCEPTED, REJECTED, SUSPENDED, COMPLETED
»»» 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.	-
»»»» status	string	true	No description	NOT_STARTED, IN_PROGRESS, COMPLETED, CANCELLED, SUSPENDED, SCHEDULED, PROPOSED, ACCEPTED, REJECTED, IN_ERROR
carePlan	object	false	A care plan is a methodical approach to resolving or managing a concern.	-
» description	string	false	A textual description of the care plan.	-
» status	string	true	A textual description of the care plan.	ACTIVE, COMPLETED, INACTIVE, IN_ERROR, REJECTED, SUSPENDED
» type	string	true	A textual description of the care plan.	VISIT, ONGOING

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.	-
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 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
createdAt	string	true	The ISO 8601 date and 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 in this field is set automatically when the goal is first created. Therefore, the field does not need to be set explicitly.	-
createdBy	Actor	true	The individual who entered the goal into the system.	-
shortTermGoals	[GoalSummary]	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	[GoalSummary]	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	[HealthConcernSummary]	false	A list of health concerns related to the goal.	-
consumer	Reference	true	The consumer with which the goal is associated.	-
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 begins making progress on the goal. This date may be different than when the goal was actually created in the system. This supports situations in which a goal is expressed but is not acted on until a later date.	-
dueDate	string	false	The ISO 8601 date when the goal should be completed.	-
statusReason	string	false	A text 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 statuses 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 are used to measure goals and activities for completion, compliance, and progress. They can have Boolean values, numeric values, or ranges of high to low values. Another option is to save targets by targetGroups parameter if it is necessary to group them. Both targets and targetGroups should not be filled in the same request body.	-
targetGroups	[TargetGroup]	false	Are used instead of targets field to group targets. A group can have a name or be unnamed. Sequencing is maintained by the natural order and applicable for both targetGroups and targets levels. Both targets and targetGroups should not be filled in the same request body.	-
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.	-
updatedAt	string	true	The ISO 8601 date and 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.	-
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 from 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 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 Health Data Intelligence data partition. Source IDs are only useful in the context of the source they are collected from, for example, in interactions between the source and Health Data Intelligence.	-
originatingSourceEncounter	OriginatingSourceEncounter	false	The encounter at which the care plan item is created. Encounters are interactions between a patient and a provider for the purpose of providing care.	-
updatedSourceEncounter	UpdatedSourceEncounter	false	The encounter at which the care plan item is updated. Encounters are interactions between a patient and a provider for the purpose of providing care.	-
priority	integer(int32)	false	The field is deprecated. The ‘priorityCategory’ should be used instead. 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.	-
priorityCategory	string	false	A string value is defining the priority of a goal. Possible values are HIGH, MEDIUM, LOW.	HIGH, MEDIUM, LOW
sourcePlanTemplate	PlanTemplateReference	false	The source plan template that was referenced when the goal was first created. This field is immutable and can be set only when the goal is initially created.	-
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. A sequence of identical progresses indicates that progress toward the goal was reviewed and updated to the same value it had previously. The progresses are sorted by start date and time in descending order. A maximum of two progresses are retrieved.	-
barriers	[BarrierLite]	false	A list of barriers for a goal.	-

Target

Name	Type	Required	Description	Accepted Values
measureTypeDescription	string	false	A textual description of the measure type. The maximum length is 1,000 characters.	-
measureType	TargetMeasureType	true	The type of parameter that is being tracked, for example, body weight, blood pressure, or hemoglobin A1c level. The parameter is a reference to an ontology context and concept.	-
detail	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.	-

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

TargetNumeric

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

TargetUnit

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

TargetRange

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

TargetGroup

Name	Type	Required	Description	Accepted Values
name	string	false	Group name.	-
targets	[Target]	true	Targets list	-

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.	-
codings	[Coding]	false	The codings of the goal definition.	-

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	NoteActor	true	A representation of the individual who entered the note into the system.	-
createdAt	string	true	The ISO 8601 date and 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	NoteActor	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 and 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.	-

NoteActor

Name	Type	Required	Description	Accepted Values
type	string	true	An enumerated list that describes the role the individual plays in relation to the note. Currently, the following types are possible: - 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
display	string	false	A textual display that describes the referenced entity.	-
reference	Reference	false	A reference to the note actor. If reference is provided, the type must be PERSONNEL.	-

CategoryReference

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

SourceIdentifier

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

PlanTemplateReference

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the plan template.	-

RelatedActivitiesSummary

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

ActivitySummary

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the activity.	-
description	string	true	The text description of the activity. \ The value in this field likely is personalized to the individual when the activity originates from an 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 not begun. - IN_PROGRESS: Indicates that the activity began 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 is scheduled but has not 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
disciplines	[DisciplineReference]	true	A list of disciplines.	-
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.”	-
updatedAt	string	false	The ISO 8601 date and 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.	-

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

BarrierLite

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the barrier.	-
status	string	true	Indicates the current state of the barrier. Currently, the following statuses are possible: - INACTIVE: Indicates that the barrier no longer exists. - ACTIVE: Indicates that the barrier is currently evident.	INACTIVE, ACTIVE
code	CodeableConceptLite	true	Describes the barrier. Includes a text description of the barrier and possibly a set of codings. While the text description can be changed, the codings cannot. Once the barrier is created, codings associated with it cannot be changed.	-

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 an 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 began 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 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
createdBy	Actor	true	The individual who entered the activity into the system.	-
createdAt	string	true	The ISO 8601 date and 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 in this field is set automatically when the activity is first created. Therefore, the field does not need to be set explicitly.	-
healthConcerns	[Reference]	false	A list of health concerns related to the activity.	-
goals	[Reference]	false	A list of goals related to the activity.	-
supportingInformation	string	false	The textual supporting information of the activity. The value in this field supports additional details about the activity. The maximum length is 1000 characters.	-
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”	-
schedule	Schedule	false	How frequently, for how long, and how many times an action should be performed.	-
targets	[Target]	false	Targets are used to measure goals and activities for completion, compliance, and progress. They can have Boolean values, numeric values, or ranges of high to low values. Another option is to save targets by TargetGroups parameter if it is necessary to group them. Neither targets nor targetGroups should be filled in the same request body.	-
targetGroups	[TargetGroup]	false	Are used instead of targets field to group targets. A group can have a name or be unnamed. Sequencing is maintained by the natural order and applicable for both targetGroups and targets levels. Neither targets nor targetGroups should be filled in the same request body.	-
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.	-
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.	-
updatedAt	string	true	The date and time when the activity was updated, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-
updatedBy	Actor	true	A representation of the individual who last modified the activity in 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 in a Health Data Intelligence 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 Health Data Intelligence.	-
originatingSourceEncounter	OriginatingSourceEncounter	false	The encounter at which the care plan item is created. Encounters are interactions between a patient and a provider for the purpose of providing care.	-
updatedSourceEncounter	UpdatedSourceEncounter	false	The encounter at which the care plan item is updated. Encounters are interactions between a patient and a provider for the purpose of providing care.	-
sourcePlanTemplate	PlanTemplateReference	false	The source plan template that was referenced when the activity was first created. This field is immutable and can be set only when the activity is initially created.	-
supportingExternalReferences	[SupportingExternalReference]	false	References to items that exist outside of Health Data Intelligence 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.	-
supportingReferences	[SupportingReference]	false	References to items that exist in Health Data Intelligence and would support the progression or completion 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	integer(int32)	true	The number of times to repeat the action in the specified period or period range.	-
period	integer(int32)	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	integer(int32)	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.	-
codings	[Coding]	false	A list of coding objects.	-

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	Actor	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 note. Currently, the following types are possible: - 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
» 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
updatedSourceEncounter	object	false	Information about the source encounter, where the note was updated. Parent entity update and version information will be updated.	-
» id	string	true	The unique ID of the encounter for a patient in a data partition.	-
» dataPartitionId	string	true	The Health Data Intelligence data partition ID of the data source.	-

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 note. Currently, the following types are possible: - 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
» 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.	-
originatingSourceEncounter	object	false	Information about the source encounter, where the note was created. Parent entity update and version information are updated.	-
» id	string	true	The unique ID of the encounter for a patient in a data partition.	-
» dataPartitionId	string	true	The Health Data Intelligence data partition ID of the data source.	-

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

postConsumersConsumeridGoalsBatch

Name	Type	Required	Description	Accepted Values
goals	[object]	true	List of goals to create. A maximum of 20 goals can be created.	-
» goalDefinitionId	string	true	The ID of the goal definition.	-
» status	string	true	Indicates the current state of the goal. Currently, 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
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), a professional in the tenant’s organization (PERSONNEL), or a consumer (SUBJECT). See the following definitions: - SUBJECT: The individual is the consumer. When the type is SUBJECT, display, reference and ID are not required. - SYSTEM: - SYSTEM is used to identify a nonliving 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, SUBJECT
» display	string	false	A text 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.	-
originatingSourceEncounter	object	false	The encounter at which the care plan item is created. Encounters are interactions between a patient and a provider for the purpose of providing care.	-
» id	string	true	The unique ID of the encounter for a patient in a data partition.	-
» dataPartitionId	string	true	The Health Data Intelligence data partition ID of the data source.	-

GoalBatchList

Name	Type	Required	Description	Accepted Values
items	[Goal]	false	A list of goals to be created in the batch endpoint.	-
totalResults	integer(int32)	true	The total number of results in the response after the POST call. The results depend on the number of goals in the POST request body.	-

putConsumersConsumeridGoals

Name	Type	Required	Description	Accepted Values
startDate	string	false	The ISO 8601 date when the individual begins making progress on the goal. This date may be different than when the goal was actually created in the system. This supports situations in which a goal is expressed but is not acted on until a later date.	-
dueDate	string	false	The ISO 8601 date when the goal should be completed.	-
statusReason	string	false	A text 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 statuses 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
priority	integer(int32)	false	The field is deprecated. The ‘priorityCategory’ should be used instead. 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.	-
priorityCategory	string	false	A string value is defining the priority of a goal. Possible values are HIGH, MEDIUM, LOW.	HIGH, MEDIUM, LOW
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 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
owners	[object]	false	No description	-
» 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.	-
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), a professional in the tenant’s organization (PERSONNEL), or a consumer (SUBJECT). See the following definitions: - SUBJECT: The individual is the consumer. When the type is SUBJECT, display, reference and ID are not required. - SYSTEM: - SYSTEM is used to identify a nonliving 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, SUBJECT
» display	string	false	A text 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.	-
targets	[object]	false	Targets are used to measure goals and activities for completion, compliance, and progress. They can have Boolean values, numeric values, or ranges of high to low values. Another option is to save targets by targetGroups parameter if it is necessary to group them. Neither targets nor targetGroups should be filled in the same request body.	-
» measureTypeDescription	string	false	A textual description of the measure type. The maximum length is 1,000 characters.	-
» measureType	object	true	The type of parameter that is being tracked, for example, body weight, blood pressure, or hemoglobin A1c level. This parameter is a reference to an ontology context and concept.	-
»» contextId	string	true	The ID of the context for the measure type. The maximum length is 60 characters.	-
»» conceptAlias	string	true	The alias of the concept in the context for the measure type.The maximum length is 1,000 characters.	-
» 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. If you want to specify a range without boundaries, include an empty range object (`"range": {}`).	-
»»» high	number(double)	false	The inclusive upper boundary of the range, which can include a decimal. The value must be greater than or equal to 0 and must have no more than 6 digits on either side of the decimal.	-
»»» low	number(double)	false	The inclusive lower boundary of the range, which can include a decimal. The value must be greater than or equal to 0 and must have no more than 6 digits on either side of the decimal.	-
»»» unitDescription	string	false	A textual description of the unit of measure. The maximum length is 1,000 characters.	-
»»» unit	object	false	The unit of measure for the range values.	-
»»»» contextId	string	true	The ID of the context for the unit of measure. The maximum length is 60 characters.	-
»»»» conceptAlias	string	true	The alias of the concept in the context for the unit of measure.The maximum length is 1,000 characters.	-
»» 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. The value must be greater than or equal to 0 and must have no more than 6 digits on either side of the decimal.	-
»»» unitDescription	string	false	A textual description of the unit of measure. The maximum length is 1,000 characters.	-
»»» unit	object	false	The unit of measure for the numeric value.	-
»»»» contextId	string	true	The ID of the context for the unit of measure. The maximum length is 60 characters.	-
»»»» conceptAlias	string	true	The alias of the concept in the context for the unit of measure.The maximum length is 1,000 characters.	-
»» 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.	TRUE, FALSE
targetGroups	[object]	false	Are used instead of targets field to group targets. A group can have a name or be unnamed. Sequencing is maintained by the natural order and applicable for both targetGroups and targets levels. Both targets and targetGroups should not be filled in the same request body.	-
» name	string	false	Maximum length is 1,000 characters.	-
» targets	[object]	true	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.	-
»» measureTypeDescription	string	false	A textual description of the measure type. The maximum length is 1,000 characters.	-
»» measureType	object	true	The type of parameter that is being tracked, for example, body weight, blood pressure, or hemoglobin A1c level. This parameter is a reference to an ontology context and concept.	-
»»» contextId	string	true	The ID of the context for the measure type. The maximum length is 60 characters.	-
»»» conceptAlias	string	true	The alias of the concept in the context for the measure type.The maximum length is 1,000 characters.	-
»» 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. If you want to specify a range without boundaries, include an empty range object (`"range": {}`).	-
»»»» high	number(double)	false	The inclusive upper boundary of the range, which can include a decimal. The value must be greater than or equal to 0 and must have no more than 6 digits on either side of the decimal.	-
»»»» low	number(double)	false	The inclusive lower boundary of the range, which can include a decimal. The value must be greater than or equal to 0 and must have no more than 6 digits on either side of the decimal.	-
»»»» unitDescription	string	false	A textual description of the unit of measure. The maximum length is 1,000 characters.	-
»»»» unit	object	false	The unit of measure for the range values.	-
»»»»» contextId	string	true	The ID of the context for the unit of measure. The maximum length is 60 characters.	-
»»»»» conceptAlias	string	true	The alias of the concept in the context for the unit of measure.The maximum length is 1,000 characters.	-
»»» 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. The value must be greater than or equal to 0 and must have no more than 6 digits on either side of the decimal.	-
»»»» unitDescription	string	false	A textual description of the unit of measure. The maximum length is 1,000 characters.	-
»»»» unit	object	false	The unit of measure for the numeric value.	-
»»»»» contextId	string	true	The ID of the context for the unit of measure. The maximum length is 60 characters.	-
»»»»» conceptAlias	string	true	The alias of the concept in the context for the unit of measure.The maximum length is 1,000 characters.	-
»»» 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.	TRUE, FALSE
progressStartAt	string	false	The date and time progress was reviewed for the goal, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. When this attribute is provided, progress is required. If this attribute is not provided but progress is changed, this is defaulted to the date and time when the goal was created or updated. Because this date and time is reflected in the goal’s progress history, a current date and time should always be provided. The API does not validate this specifically, but providing a past or future date and time may cause the goal’s progress history to be inconsistently sorted.	-
updatedSourceEncounter	object	false	The encounter at which the care plan item is updated. Encounters are interactions between a patient and a provider for the purpose of providing care.	-
» id	string	true	The unique ID of the encounter for a patient in a data partition.	-
» dataPartitionId	string	true	The Health Data Intelligence data partition ID of the data source.	-

postConsumersConsumeridGoals

Name	Type	Required	Description	Accepted Values
startDate	string	false	The ISO 8601 date when the individual begins making progress on the goal. This date may be different than when the goal was actually created in the system. This supports situations in which a goal is expressed but is not acted on until a later date.	-
dueDate	string	false	The ISO 8601 date when the goal should be completed.	-
statusReason	string	false	A text 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 statuses 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
priority	integer(int32)	false	The field is deprecated. The ‘priorityCategory’ should be used instead. 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.	-
priorityCategory	string	false	A string value is defining the priority of a goal. Possible values are HIGH, MEDIUM, LOW.	HIGH, MEDIUM, LOW
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 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
owners	[object]	false	No description	-
» 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.	-
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), a professional in the tenant’s organization (PERSONNEL), or a consumer (SUBJECT). See the following definitions: - SUBJECT: The individual is the consumer. When the type is SUBJECT, display, reference and ID are not required. - SYSTEM: - SYSTEM is used to identify a nonliving 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, SUBJECT
» display	string	false	A text 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 Health Data Intelligence partition ID of the data source.	-
targets	[object]	false	Targets are used to measure goals and activities for completion, compliance, and progress. They can have Boolean values, numeric values, or ranges of high to low values. Another option is to save targets by targetGroups parameter if it is necessary to group them. Neither targets nor targetGroups should be filled in the same request body.	-
» measureTypeDescription	string	false	A textual description of the measure type. The maximum length is 1,000 characters.	-
» measureType	object	true	The type of parameter that is being tracked, for example, body weight, blood pressure, or hemoglobin A1c level. This parameter is a reference to an ontology context and concept.	-
»» contextId	string	true	The ID of the context for the measure type. The maximum length is 60 characters.	-
»» conceptAlias	string	true	The alias of the concept in the context for the measure type.The maximum length is 1,000 characters.	-
» 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. If you want to specify a range without boundaries, include an empty range object (`"range": {}`).	-
»»» high	number(double)	false	The inclusive upper boundary of the range, which can include a decimal. The value must be greater than or equal to 0 and must have no more than 6 digits on either side of the decimal.	-
»»» low	number(double)	false	The inclusive lower boundary of the range, which can include a decimal. The value must be greater than or equal to 0 and must have no more than 6 digits on either side of the decimal.	-
»»» unitDescription	string	false	A textual description of the unit of measure. The maximum length is 1,000 characters.	-
»»» unit	object	false	The unit of measure for the range values.	-
»»»» contextId	string	true	The ID of the context for the unit of measure. The maximum length is 60 characters.	-
»»»» conceptAlias	string	true	The alias of the concept in the context for the unit of measure.The maximum length is 1,000 characters.	-
»» 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. The value must be greater than or equal to 0 and must have no more than 6 digits on either side of the decimal.	-
»»» unitDescription	string	false	A textual description of the unit of measure. The maximum length is 1,000 characters.	-
»»» unit	object	false	The unit of measure for the numeric value.	-
»»»» contextId	string	true	The ID of the context for the unit of measure. The maximum length is 60 characters.	-
»»»» conceptAlias	string	true	The alias of the concept in the context for the unit of measure.The maximum length is 1,000 characters.	-
»» 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.	TRUE, FALSE
targetGroups	[object]	false	Are used instead of targets field to group targets. A group can have a name or be unnamed. Sequencing is maintained by the natural order and applicable for both targetGroups and targets levels. Both targets and targetGroups should not be filled in the same request body.	-
» name	string	false	Maximum length is 1,000 characters.	-
» targets	[object]	true	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.	-
»» measureTypeDescription	string	false	A textual description of the measure type. The maximum length is 1,000 characters.	-
»» measureType	object	true	The type of parameter that is being tracked, for example, body weight, blood pressure, or hemoglobin A1c level. This parameter is a reference to an ontology context and concept.	-
»»» contextId	string	true	The ID of the context for the measure type. The maximum length is 60 characters.	-
»»» conceptAlias	string	true	The alias of the concept in the context for the measure type.The maximum length is 1,000 characters.	-
»» 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. If you want to specify a range without boundaries, include an empty range object (`"range": {}`).	-
»»»» high	number(double)	false	The inclusive upper boundary of the range, which can include a decimal. The value must be greater than or equal to 0 and must have no more than 6 digits on either side of the decimal.	-
»»»» low	number(double)	false	The inclusive lower boundary of the range, which can include a decimal. The value must be greater than or equal to 0 and must have no more than 6 digits on either side of the decimal.	-
»»»» unitDescription	string	false	A textual description of the unit of measure. The maximum length is 1,000 characters.	-
»»»» unit	object	false	The unit of measure for the range values.	-
»»»»» contextId	string	true	The ID of the context for the unit of measure. The maximum length is 60 characters.	-
»»»»» conceptAlias	string	true	The alias of the concept in the context for the unit of measure.The maximum length is 1,000 characters.	-
»»» 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. The value must be greater than or equal to 0 and must have no more than 6 digits on either side of the decimal.	-
»»»» unitDescription	string	false	A textual description of the unit of measure. The maximum length is 1,000 characters.	-
»»»» unit	object	false	The unit of measure for the numeric value.	-
»»»»» contextId	string	true	The ID of the context for the unit of measure. The maximum length is 60 characters.	-
»»»»» conceptAlias	string	true	The alias of the concept in the context for the unit of measure.The maximum length is 1,000 characters.	-
»»» 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.	TRUE, FALSE
originatingSourceEncounter	object	false	The encounter at which the care plan item is created. Encounters are interactions between a patient and a provider for the purpose of providing care.	-
» id	string	true	The unique ID of the encounter for a patient in a data partition.	-
» dataPartitionId	string	true	The Health Data Intelligence data partition ID of the data source.	-
progressStartAt	string	false	The date and time progress was reviewed for the goal, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. When this attribute is provided, progress is required. If this attribute is not provided but progress is changed, this is defaulted to the date and time when the goal was created or updated. Because this date and time is reflected in the goal’s progress history, a current date and time should always be provided. The API does not validate this specifically, but providing a past or future date and time may cause the goal’s progress history to be inconsistently sorted.	-
sourcePlanTemplate	object	false	A reference to the plan template.	-
» id	string	true	The ID of the plan template.	-

ConsumerTemplate

Name	Type	Required	Description	Accepted Values
healthConcerns	[HealthConcernLite]	false	The health concerns on a person’s plan that relate to the health concern definition in the context of this plan template. The list is primarily sorted by text in ascending alphabetic order and secondarily sorted by onset date in reverse chronological order.	-
goals	[ConsumerTemplateGoal]	false	The goals on a person’s plan that relate to the goal definition in the context of this plan template. The list is primarily sorted by description in ascending alphabetic order and secondarily sorted by start date in reverse chronological order.	-
activities	[ConsumerTemplateActivity]	false	The activities on a person’s plan that relate to the activity definition in the context of this plan template. The list is primarily sorted by description in ascending alphabetic order and secondarily sorted by start date in reverse chronological order.	-

HealthConcernLite

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the health concern.	-
status	string	true	The current status of the health concern. The following statuses are possible: - ACCEPTED: Indicates that the health concern was accepted or acknowledged. - ACTIVE: Indicates that signs or symptoms of the health concern are currently evident. - IN_ERROR: Indicates that the health concern was mistakenly identified. - PROPOSED: Indicates that the health concern was proposed. - REJECTED: Indicates that the health concern was rejected. - RELAPSE: Indicates that signs or symptoms of the health concern have returned after a period of improvement or remission. - REMISSION: Indicates that signs or symptoms of the health concern are no longer evident but are at risk of returning. - RESOLVED: Indicates that signs or symptoms of the health concern are no longer evident. - INACTIVE: Indicates that the person is no longer experiencing symptoms of the concern or that evidence of the concern no longer exists.	-
code	CodeableConceptLite	true	Describes a health concern, for example, obesity or hypertension. Health concerns can represent traditional medical problems, risks, complaints, or symptoms as well as social concerns. Includes a textual description of the health concern and possibly a set of codings. While the textual description can be changed, the codings cannot. After the health concern is created, codings associated with it cannot be changed.	-
createdBy	HealthConcernActor	true	The individual who created the health concern in the system.	-
createdAt	string	true	The date and time when the health concern 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 health concern is first created; therefore, the field does not need to be set explicitly.	-
healthConcernDefinitionId	string	true	The health concern definition that was referenced when the health concern was created. This field can be set only when the health concern is initially created.	-

HealthConcernActor

Name	Type	Required	Description	Accepted Values
type	string	true	The role the individual plays in relation to the health concern. Currently, the individual could be the focus of the health concern itself (SUBJECT) or a professional in the tenant’s organization (PERSONNEL).	PERSONNEL, SUBJECT
reference	Reference	false	A reference to the individual. If a reference is provided, the type must be PERSONNEL.	-

ConsumerTemplateGoal

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the goal.	-
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 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
createdAt	string	true	The ISO 8601 date and 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 in this field is set automatically when the goal is first created. Therefore, the field does not need to be set explicitly.	-
createdBy	Actor	true	The individual who entered the goal into the system.	-
shortTermGoals	[GoalSummary]	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	[GoalSummary]	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	[HealthConcernSummary]	false	A list of health concerns related to the goal.	-
goalDefinitionId	string	true	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.	-

ConsumerTemplateActivity

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 an 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 began 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 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
createdBy	Actor	true	The individual who entered the activity into the system.	-
createdAt	string	true	The ISO 8601 date and 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 in this field is set automatically when the activity is first created. Therefore, the field does not need to be set explicitly.	-
healthConcerns	[Reference]	false	A list of health concerns related to the activity.	-
goals	[Reference]	false	A list of goals related to the activity.	-
activityDefinitionId	string	true	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.	-

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 note. Currently, the following types are possible: - 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
» 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
updatedSourceEncounter	object	false	Information about the source encounter, where the note was updated. Parent entity update and version information will be updated.	-
» id	string	true	The unique ID of the encounter for a patient in a data partition.	-
» dataPartitionId	string	true	The Health Data Intelligence data partition ID of the data source.	-

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 note. Currently, the following types are possible: - 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
» 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.	-
originatingSourceEncounter	object	false	Information about the source encounter, where the note was created. Parent entity update and version information are updated.	-
» id	string	true	The unique ID of the encounter for a patient in a data partition.	-
» dataPartitionId	string	true	The Health Data Intelligence data partition ID of the data source.	-

postConsumersConsumeridActivitiesBatch

Name	Type	Required	Description	Accepted Values
activities	[object]	true	A list of activities to create. A maximum of 20 activities can be created.	-
» activityDefinitionId	string	true	The ID of the activity definition.	-
» status	string	true	Indicates the current state of the activity. Currently, the following statuses are possible: - PLANNED: Indicates that the activity is planned but is not yet being pursued. - IN_PROGRESS: Indicates that the activity is being pursued and is ongoing. - CANCELLED: Indicates that the activity will no longer be pursued. - IN_ERROR: Indicates that the activity was mistakenly identified. - PROPOSED: Indicates that the activity is proposed. - ACCEPTED: Indicates that the activity is accepted or acknowledged. - REJECTED: Indicates that the activity is rejected. - SUSPENDED: Indicates that the activity is on hold. - COMPLETED: Indicates that the activity is in a final state of completion.	NOT_STARTED, IN_PROGRESS, COMPLETED, CANCELLED, SUSPENDED, SCHEDULED, PROPOSED, ACCEPTED, REJECTED, IN_ERROR
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 entity. Currently, it could be an application or algorithm (SYSTEM), a professional in the tenant’s organization (PERSONNEL), or a consumer (SUBJECT). See the following definitions: - SUBJECT: The individual is the consumer. When the type is SUBJECT, display, reference and ID are not required. - SYSTEM: - SYSTEM is used to identify a nonliving 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, SUBJECT
» display	string	false	A text display that describes the referenced entity.	-
» reference	object	false	A reference to the individual. If a reference is provided, the type must be PERSONNEL.	-
»» id	string	true	The ID of the referenced entity.	-
originatingSourceEncounter	object	false	The encounter at which the care plan item is created. Encounters are interactions between a patient and a provider for the purpose of providing care.	-
» id	string	true	The unique ID of the encounter for a patient in a data partition.	-
» dataPartitionId	string	true	The Health Data Intelligence data partition ID of the data source.	-

ActivityBatchList

Name	Type	Required	Description	Accepted Values
items	[Activity]	false	A list of activities to be created in the batch endpoint.	-
totalResults	integer(int32)	true	The total results in the response after the post call. The total results depend on the number of results in the request body in post call.	-

putConsumersConsumeridActivities

Name	Type	Required	Description	Accepted Values
supportingInformation	string	false	The textual supporting information of the activity. The value in this field supports additional details about the activity. The maximum length is 1000 characters.	-
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”	-
statusReason	string	false	A textual representation of the reason the activity is in its current status.	-
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 an 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 began 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 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
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	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.	-
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 Health Data Intelligence 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 Health Data Intelligence 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 Health Data Intelligence.	-
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 entity. Currently, it could be an application or algorithm (SYSTEM), a professional in the tenant’s organization (PERSONNEL), or a consumer (SUBJECT). See the following definitions: - SUBJECT: The individual is the consumer. When the type is SUBJECT, display, reference and ID are not required. - SYSTEM: - SYSTEM is used to identify a nonliving 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, SUBJECT
» display	string	false	A text 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.	-
targets	[object]	false	Targets are used to measure goals and activities for completion, compliance, and progress. They can have Boolean values, numeric values, or ranges of high to low values. Another option is to save targets by targetGroups parameter if it is necessary to group them. Neither targets nor targetGroups should be filled in the same request body.	-
» measureTypeDescription	string	false	A textual description of the measure type. The maximum length is 1,000 characters.	-
» measureType	object	true	The type of parameter that is being tracked, for example, body weight, blood pressure, or hemoglobin A1c level. This parameter is a reference to an ontology context and concept.	-
»» contextId	string	true	The ID of the context for the measure type. The maximum length is 60 characters.	-
»» conceptAlias	string	true	The alias of the concept in the context for the measure type.The maximum length is 1,000 characters.	-
» 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. If you want to specify a range without boundaries, include an empty range object (`"range": {}`).	-
»»» high	number(double)	false	The inclusive upper boundary of the range, which can include a decimal. The value must be greater than or equal to 0 and must have no more than 6 digits on either side of the decimal.	-
»»» low	number(double)	false	The inclusive lower boundary of the range, which can include a decimal. The value must be greater than or equal to 0 and must have no more than 6 digits on either side of the decimal.	-
»»» unitDescription	string	false	A textual description of the unit of measure. The maximum length is 1,000 characters.	-
»»» unit	object	false	The unit of measure for the range values.	-
»»»» contextId	string	true	The ID of the context for the unit of measure. The maximum length is 60 characters.	-
»»»» conceptAlias	string	true	The alias of the concept in the context for the unit of measure.The maximum length is 1,000 characters.	-
»» 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. The value must be greater than or equal to 0 and must have no more than 6 digits on either side of the decimal.	-
»»» unitDescription	string	false	A textual description of the unit of measure. The maximum length is 1,000 characters.	-
»»» unit	object	false	The unit of measure for the numeric value.	-
»»»» contextId	string	true	The ID of the context for the unit of measure. The maximum length is 60 characters.	-
»»»» conceptAlias	string	true	The alias of the concept in the context for the unit of measure.The maximum length is 1,000 characters.	-
»» 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.	TRUE, FALSE
targetGroups	[object]	false	Are used instead of targets field to group targets. A group can have a name or be unnamed. Sequencing is maintained by the natural order and applicable for both targetGroups and targets levels. Both targets and targetGroups should not be filled in the same request body.	-
» name	string	false	Maximum length is 1,000 characters.	-
» targets	[object]	true	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.	-
»» measureTypeDescription	string	false	A textual description of the measure type. The maximum length is 1,000 characters.	-
»» measureType	object	true	The type of parameter that is being tracked, for example, body weight, blood pressure, or hemoglobin A1c level. This parameter is a reference to an ontology context and concept.	-
»»» contextId	string	true	The ID of the context for the measure type. The maximum length is 60 characters.	-
»»» conceptAlias	string	true	The alias of the concept in the context for the measure type.The maximum length is 1,000 characters.	-
»» 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. If you want to specify a range without boundaries, include an empty range object (`"range": {}`).	-
»»»» high	number(double)	false	The inclusive upper boundary of the range, which can include a decimal. The value must be greater than or equal to 0 and must have no more than 6 digits on either side of the decimal.	-
»»»» low	number(double)	false	The inclusive lower boundary of the range, which can include a decimal. The value must be greater than or equal to 0 and must have no more than 6 digits on either side of the decimal.	-
»»»» unitDescription	string	false	A textual description of the unit of measure. The maximum length is 1,000 characters.	-
»»»» unit	object	false	The unit of measure for the range values.	-
»»»»» contextId	string	true	The ID of the context for the unit of measure. The maximum length is 60 characters.	-
»»»»» conceptAlias	string	true	The alias of the concept in the context for the unit of measure.The maximum length is 1,000 characters.	-
»»» 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. The value must be greater than or equal to 0 and must have no more than 6 digits on either side of the decimal.	-
»»»» unitDescription	string	false	A textual description of the unit of measure. The maximum length is 1,000 characters.	-
»»»» unit	object	false	The unit of measure for the numeric value.	-
»»»»» contextId	string	true	The ID of the context for the unit of measure. The maximum length is 60 characters.	-
»»»»» conceptAlias	string	true	The alias of the concept in the context for the unit of measure.The maximum length is 1,000 characters.	-
»»» 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.	TRUE, FALSE
updatedSourceEncounter	object	false	The encounter at which the care plan item is updated. Encounters are interactions between a patient and a provider for the purpose of providing care.	-
» id	string	true	The unique ID of the encounter for a patient in a data partition.	-
» dataPartitionId	string	true	The Health Data Intelligence data partition ID of the data source.	-

postConsumersConsumeridActivities

Name	Type	Required	Description	Accepted Values
supportingInformation	string	false	The textual supporting information of the activity. The value in this field supports additional details about the activity. The maximum length is 1000 characters.	-
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”	-
statusReason	string	false	A textual representation of the reason the activity is in its current status.	-
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 an 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 began 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 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
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	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.	-
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 Health Data Intelligence 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 Health Data Intelligence 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 Health Data Intelligence.	-
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 entity. Currently, it could be an application or algorithm (SYSTEM), a professional in the tenant’s organization (PERSONNEL), or a consumer (SUBJECT). See the following definitions: - SUBJECT: The individual is the consumer. When the type is SUBJECT, display, reference and ID are not required. - SYSTEM: - SYSTEM is used to identify a nonliving 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, SUBJECT
» display	string	false	A text 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 Health Data Intelligence partition ID of the data source.	-
targets	[object]	false	Targets are used to measure goals and activities for completion, compliance, and progress. They can have Boolean values, numeric values, or ranges of high to low values. Another option is to save targets by targetGroups parameter if it is necessary to group them. Neither targets nor targetGroups should be filled in the same request body.	-
» measureTypeDescription	string	false	A textual description of the measure type. The maximum length is 1,000 characters.	-
» measureType	object	true	The type of parameter that is being tracked, for example, body weight, blood pressure, or hemoglobin A1c level. This parameter is a reference to an ontology context and concept.	-
»» contextId	string	true	The ID of the context for the measure type. The maximum length is 60 characters.	-
»» conceptAlias	string	true	The alias of the concept in the context for the measure type.The maximum length is 1,000 characters.	-
» 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. If you want to specify a range without boundaries, include an empty range object (`"range": {}`).	-
»»» high	number(double)	false	The inclusive upper boundary of the range, which can include a decimal. The value must be greater than or equal to 0 and must have no more than 6 digits on either side of the decimal.	-
»»» low	number(double)	false	The inclusive lower boundary of the range, which can include a decimal. The value must be greater than or equal to 0 and must have no more than 6 digits on either side of the decimal.	-
»»» unitDescription	string	false	A textual description of the unit of measure. The maximum length is 1,000 characters.	-
»»» unit	object	false	The unit of measure for the range values.	-
»»»» contextId	string	true	The ID of the context for the unit of measure. The maximum length is 60 characters.	-
»»»» conceptAlias	string	true	The alias of the concept in the context for the unit of measure.The maximum length is 1,000 characters.	-
»» 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. The value must be greater than or equal to 0 and must have no more than 6 digits on either side of the decimal.	-
»»» unitDescription	string	false	A textual description of the unit of measure. The maximum length is 1,000 characters.	-
»»» unit	object	false	The unit of measure for the numeric value.	-
»»»» contextId	string	true	The ID of the context for the unit of measure. The maximum length is 60 characters.	-
»»»» conceptAlias	string	true	The alias of the concept in the context for the unit of measure.The maximum length is 1,000 characters.	-
»» 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.	TRUE, FALSE
targetGroups	[object]	false	Are used instead of targets field to group targets. A group can have a name or be unnamed. Sequencing is maintained by the natural order and applicable for both targetGroups and targets levels. Both targets and targetGroups should not be filled in the same request body.	-
» name	string	false	Maximum length is 1,000 characters.	-
» targets	[object]	true	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.	-
»» measureTypeDescription	string	false	A textual description of the measure type. The maximum length is 1,000 characters.	-
»» measureType	object	true	The type of parameter that is being tracked, for example, body weight, blood pressure, or hemoglobin A1c level. This parameter is a reference to an ontology context and concept.	-
»»» contextId	string	true	The ID of the context for the measure type. The maximum length is 60 characters.	-
»»» conceptAlias	string	true	The alias of the concept in the context for the measure type.The maximum length is 1,000 characters.	-
»» 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. If you want to specify a range without boundaries, include an empty range object (`"range": {}`).	-
»»»» high	number(double)	false	The inclusive upper boundary of the range, which can include a decimal. The value must be greater than or equal to 0 and must have no more than 6 digits on either side of the decimal.	-
»»»» low	number(double)	false	The inclusive lower boundary of the range, which can include a decimal. The value must be greater than or equal to 0 and must have no more than 6 digits on either side of the decimal.	-
»»»» unitDescription	string	false	A textual description of the unit of measure. The maximum length is 1,000 characters.	-
»»»» unit	object	false	The unit of measure for the range values.	-
»»»»» contextId	string	true	The ID of the context for the unit of measure. The maximum length is 60 characters.	-
»»»»» conceptAlias	string	true	The alias of the concept in the context for the unit of measure.The maximum length is 1,000 characters.	-
»»» 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. The value must be greater than or equal to 0 and must have no more than 6 digits on either side of the decimal.	-
»»»» unitDescription	string	false	A textual description of the unit of measure. The maximum length is 1,000 characters.	-
»»»» unit	object	false	The unit of measure for the numeric value.	-
»»»»» contextId	string	true	The ID of the context for the unit of measure. The maximum length is 60 characters.	-
»»»»» conceptAlias	string	true	The alias of the concept in the context for the unit of measure.The maximum length is 1,000 characters.	-
»»» 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.	TRUE, FALSE
originatingSourceEncounter	object	false	The encounter at which the care plan item is created. Encounters are interactions between a patient and a provider for the purpose of providing care.	-
» id	string	true	The unique ID of the encounter for a patient in a data partition.	-
» dataPartitionId	string	true	The Health Data Intelligence data partition ID of the data source.	-
sourcePlanTemplate	object	false	A reference to the plan template.	-
» id	string	true	The ID of the plan template.	-

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 Health Data Intelligence 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 Health Data Intelligence 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 Health Data Intelligence.	-
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	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.	-
» measureTypeDescription	string	false	A textual description of the measure type. The maximum length is 1,000 characters.	-
» 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. The maximum length is 60 characters.	-
»» conceptAlias	string	true	The alias of the concept in the context for the measure type.The maximum length is 1,000 characters.	-
» 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	Indicates the type of detail provided.	BOOLEAN, NUMERIC, RANGE
»» 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.	TRUE, FALSE
»» 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. The value must be greater than or equal to 0 and must have no more than 6 digits on either side of the decimal.	-
»»» unitDescription	string	false	A textual description of the unit measure. The maximum length is 1,000 characters.	-
»»» unit	object	false	The unit of measure for the numeric value.	-
»»»» contextId	string	true	The ID of the context for the unit of measure. The maximum length is 60 characters.	-
»»»» conceptAlias	string	true	The alias of the concept in the context for the unit of measure.The maximum length is 1,000 characters.	-
»» 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. The value must be greater than or equal to 0 and must have no more than 6 digits on either side of the decimal.	-
»»» low	number(double)	false	The inclusive lower boundary of the range, which can include a decimal. The value must be greater than or equal to 0 and must have no more than 6 digits on either side of the decimal.	-
»»» unitDescription	string	false	A textual description of the unit measure. The maximum length is 1,000 characters.	-
»»» unit	object	false	The unit of measure for the range values.	-
»»»» contextId	string	true	The ID of the context for the unit of measure. The maximum length is 60 characters.	-
»»»» conceptAlias	string	true	The alias of the concept in the context for the unit of measure.The maximum length is 1,000 characters.	-
targetGroups	[object]	false	Used instead of targets field to group targets. A group can have a name or be unnamed. Sequencing is maintained by the natural order and applicable for both targetGroups and targets levels. Both targets and TargetGroups shouldn’t be filled in the same request body.	-
» name	string	false	Maximum length is 1,000 characters.	-
» targets	[object]	true	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.	-
»» measureTypeDescription	string	false	A textual description of the measure type. The maximum length is 1,000 characters.	-
»» 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. The maximum length is 60 characters.	-
»»» conceptAlias	string	true	The alias of the concept in the context for the measure type.The maximum length is 1,000 characters.	-
»» 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	Indicates the type of detail provided.	BOOLEAN, NUMERIC, RANGE
»»» 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.	TRUE, FALSE
»»» 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. The value must be greater than or equal to 0 and must have no more than 6 digits on either side of the decimal.	-
»»»» unitDescription	string	false	A textual description of the unit measure. The maximum length is 1,000 characters.	-
»»»» unit	object	false	The unit of measure for the numeric value.	-
»»»»» contextId	string	true	The ID of the context for the unit of measure. The maximum length is 60 characters.	-
»»»»» conceptAlias	string	true	The alias of the concept in the context for the unit of measure.The maximum length is 1,000 characters.	-
»»» 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. The value must be greater than or equal to 0 and must have no more than 6 digits on either side of the decimal.	-
»»»» low	number(double)	false	The inclusive lower boundary of the range, which can include a decimal. The value must be greater than or equal to 0 and must have no more than 6 digits on either side of the decimal.	-
»»»» unitDescription	string	false	A textual description of the unit measure. The maximum length is 1,000 characters.	-
»»»» unit	object	false	The unit of measure for the range values.	-
»»»»» contextId	string	true	The ID of the context for the unit of measure. The maximum length is 60 characters.	-
»»»»» conceptAlias	string	true	The alias of the concept in the context for the unit of measure.The maximum length is 1,000 characters.	-

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 Health Data Intelligence 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 Health Data Intelligence 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 Health Data Intelligence.	-
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	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.	-
» measureTypeDescription	string	false	A textual description of the measure type. The maximum length is 1,000 characters.	-
» 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. The maximum length is 60 characters.	-
»» conceptAlias	string	true	The alias of the concept in the context for the measure type.The maximum length is 1,000 characters.	-
» 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	Indicates the type of detail provided.	BOOLEAN, NUMERIC, RANGE
»» 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.	TRUE, FALSE
»» 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. The value must be greater than or equal to 0 and must have no more than 6 digits on either side of the decimal.	-
»»» unitDescription	string	false	A textual description of the unit measure. The maximum length is 1,000 characters.	-
»»» unit	object	false	The unit of measure for the numeric value.	-
»»»» contextId	string	true	The ID of the context for the unit of measure. The maximum length is 60 characters.	-
»»»» conceptAlias	string	true	The alias of the concept in the context for the unit of measure.The maximum length is 1,000 characters.	-
»» 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. The value must be greater than or equal to 0 and must have no more than 6 digits on either side of the decimal.	-
»»» low	number(double)	false	The inclusive lower boundary of the range, which can include a decimal. The value must be greater than or equal to 0 and must have no more than 6 digits on either side of the decimal.	-
»»» unitDescription	string	false	A textual description of the unit measure. The maximum length is 1,000 characters.	-
»»» unit	object	false	The unit of measure for the range values.	-
»»»» contextId	string	true	The ID of the context for the unit of measure. The maximum length is 60 characters.	-
»»»» conceptAlias	string	true	The alias of the concept in the context for the unit of measure.The maximum length is 1,000 characters.	-
targetGroups	[object]	false	Used instead of targets field to group targets. A group can have a name or be unnamed. Sequencing is maintained by the natural order and applicable for both targetGroups and targets levels. Both targets and TargetGroups shouldn’t be filled in the same request body.	-
» name	string	false	Maximum length is 1,000 characters.	-
» targets	[object]	true	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.	-
»» measureTypeDescription	string	false	A textual description of the measure type. The maximum length is 1,000 characters.	-
»» 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. The maximum length is 60 characters.	-
»»» conceptAlias	string	true	The alias of the concept in the context for the measure type.The maximum length is 1,000 characters.	-
»» 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	Indicates the type of detail provided.	BOOLEAN, NUMERIC, RANGE
»»» 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.	TRUE, FALSE
»»» 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. The value must be greater than or equal to 0 and must have no more than 6 digits on either side of the decimal.	-
»»»» unitDescription	string	false	A textual description of the unit measure. The maximum length is 1,000 characters.	-
»»»» unit	object	false	The unit of measure for the numeric value.	-
»»»»» contextId	string	true	The ID of the context for the unit of measure. The maximum length is 60 characters.	-
»»»»» conceptAlias	string	true	The alias of the concept in the context for the unit of measure.The maximum length is 1,000 characters.	-
»»» 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. The value must be greater than or equal to 0 and must have no more than 6 digits on either side of the decimal.	-
»»»» low	number(double)	false	The inclusive lower boundary of the range, which can include a decimal. The value must be greater than or equal to 0 and must have no more than 6 digits on either side of the decimal.	-
»»»» unitDescription	string	false	A textual description of the unit measure. The maximum length is 1,000 characters.	-
»»»» unit	object	false	The unit of measure for the range values.	-
»»»»» contextId	string	true	The ID of the context for the unit of measure. The maximum length is 60 characters.	-
»»»»» conceptAlias	string	true	The alias of the concept in the context for the unit of measure.The maximum length is 1,000 characters.	-

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

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

Barriers

Name	Type	Required	Description	Accepted Values
items	[Barrier]	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.	-

postGoalsGoalidBarriers

Name	Type	Required	Description	Accepted Values
barriers	[object]	true	List of barriers to create. A maximum of 20 barriers can be created.	-
» code	object	true	Describes a barrier definition.	-
»» text	string	true	A human-readable, potentially personalized description of the barrier. This field must be provided for every barrier.	-
»» codings	[object]	false	A list of codified values from a standard code system.	-
»»» code	string	true	The unique ID of the code.	-
»»» system	string	true	The ID of the coding system that gives meaning to the code.	-
» status	string	true	Indicates the current state of the barrier. Currently, the following statuses are possible: - INACTIVE: Indicates that the barrier no longer exists. - ACTIVE: Indicates that the barrier is currently evident.	INACTIVE, ACTIVE
» concept	object	false	The most applicable concept to use for coding purposes when instantiating the defined barrier. Or, for searching purposes, the set of codes that are most applicable.	-
»» contextId	string	true	The unique context ID defined in the ontology.	-
»» conceptAlias	string	true	The text mnemonic defined in the ontology that identifies the concept in the context.	-
» createdBy	object	false	Title of the creator: system, person	-
»» 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, SUBJECT
»» display	string	false	A text display that describes the referenced individual.	-
»» reference	object	false	A reference to the individual. If reference is provided, the type must be PERSONNEL.	-
»»» id	string	true	The ID of the reference individual.	-
» barrierDefinition	object	false	A reference to the barrier definition.	-
»» id	string	true	The ID of the barrier definition.	-
createdBy	object	false	Title of the creator: system, person	-
originatingSourceEncounter	object	false	Information about the source encounter, where the barrier was created. Parent entity update and version information will be updated.	-

BarrierList

Name	Type	Required	Description	Accepted Values
items	[Barrier]	false	A list of barriers to be created.	-
totalResults	integer(int32)	true	Total results in the response after the post call. Depends on the number of results in the request body in post call.	-

putGoalsGoalidBarriers

Name	Type	Required	Description	Accepted Values
code	object	true	Describes a barrier definition.	-
» text	string	true	A human-readable, potentially personalized description of the barrier. This field must be provided for every barrier.	-
» codings	[object]	false	A list of codified values from a standard code system.	-
»» code	string	true	The unique ID of the code.	-
»» system	string	true	The ID of the coding system that gives meaning to the code.	-
status	string	true	Indicates the current state of the barrier. Currently, the following statuses are possible: - INACTIVE: Indicates that the barrier no longer exists. - ACTIVE: Indicates that the barrier is currently evident.	INACTIVE, ACTIVE
concept	object	false	The most applicable concept to use for coding purposes when instantiating the defined barrier. Or, for searching purposes, the set of codes that are most applicable.	-
» contextId	string	true	The unique context ID defined in the ontology.	-
» conceptAlias	string	true	The text mnemonic defined in the ontology that identifies the concept in the context.	-
updatedBy	object	true	A representation of the individual who entered the barrier into the system.	-
» 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, SUBJECT
» display	string	false	A text display that describes the referenced individual.	-
» reference	object	false	A reference to the individual. If reference is provided, the type must be PERSONNEL.	-
»» id	string	true	The ID of the reference individual.	-
updatedSourceEncounter	object	false	The encounter at which the care plan item is updated. Encounters are interactions between a patient and a provider for the purpose of providing care.	-
» id	string	true	The unique ID of the encounter for a patient in a data partition.	-
» dataPartitionId	string	true	The Health Data Intelligence data partition ID of the data source.	-

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

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

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.	-
status	string	true	The status of the goal definition.	ACTIVE, INACTIVE
targets	[object]	false	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.	-
» measureTypeDescription	string	false	A textual description of the measure type. The maximum length is 1,000 characters.	-
» 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. The maximum length is 60 characters.	-
»» conceptAlias	string	true	The alias of the concept in the context for the measure type.The maximum length is 1,000 characters.	-
» 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	Indicates the type of detail provided.	BOOLEAN, NUMERIC, RANGE
»» 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.	TRUE, FALSE
»» 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. The value must be greater than or equal to 0 and must have no more than 6 digits on either side of the decimal.	-
»»» unitDescription	string	false	A textual description of the unit measure. The maximum length is 1,000 characters.	-
»»» unit	object	false	The unit of measure for the numeric value.	-
»»»» contextId	string	true	The ID of the context for the unit of measure. The maximum length is 60 characters.	-
»»»» conceptAlias	string	true	The alias of the concept in the context for the unit of measure.The maximum length is 1,000 characters.	-
»» 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. The value must be greater than or equal to 0 and must have no more than 6 digits on either side of the decimal.	-
»»» low	number(double)	false	The inclusive lower boundary of the range, which can include a decimal. The value must be greater than or equal to 0 and must have no more than 6 digits on either side of the decimal.	-
»»» unitDescription	string	false	A textual description of the unit measure. The maximum length is 1,000 characters.	-
»»» unit	object	false	The unit of measure for the range values.	-
»»»» contextId	string	true	The ID of the context for the unit of measure. The maximum length is 60 characters.	-
»»»» conceptAlias	string	true	The alias of the concept in the context for the unit of measure.The maximum length is 1,000 characters.	-
targetGroups	[object]	false	Used instead of targets field to group targets. A group can have a name or be unnamed. Sequencing is maintained by the natural order and applicable for both targetGroups and targets levels. Both targets and TargetGroups shouldn’t be filled in the same request body.	-
» name	string	false	Maximum length is 1,000 characters.	-
» targets	[object]	true	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.	-
»» measureTypeDescription	string	false	A textual description of the measure type. The maximum length is 1,000 characters.	-
»» 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. The maximum length is 60 characters.	-
»»» conceptAlias	string	true	The alias of the concept in the context for the measure type.The maximum length is 1,000 characters.	-
»» 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	Indicates the type of detail provided.	BOOLEAN, NUMERIC, RANGE
»»» 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.	TRUE, FALSE
»»» 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. The value must be greater than or equal to 0 and must have no more than 6 digits on either side of the decimal.	-
»»»» unitDescription	string	false	A textual description of the unit measure. The maximum length is 1,000 characters.	-
»»»» unit	object	false	The unit of measure for the numeric value.	-
»»»»» contextId	string	true	The ID of the context for the unit of measure. The maximum length is 60 characters.	-
»»»»» conceptAlias	string	true	The alias of the concept in the context for the unit of measure.The maximum length is 1,000 characters.	-
»»» 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. The value must be greater than or equal to 0 and must have no more than 6 digits on either side of the decimal.	-
»»»» low	number(double)	false	The inclusive lower boundary of the range, which can include a decimal. The value must be greater than or equal to 0 and must have no more than 6 digits on either side of the decimal.	-
»»»» unitDescription	string	false	A textual description of the unit measure. The maximum length is 1,000 characters.	-
»»»» unit	object	false	The unit of measure for the range values.	-
»»»»» contextId	string	true	The ID of the context for the unit of measure. The maximum length is 60 characters.	-
»»»»» conceptAlias	string	true	The alias of the concept in the context for the unit of measure.The maximum length is 1,000 characters.	-

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	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.	-
» measureTypeDescription	string	false	A textual description of the measure type. The maximum length is 1,000 characters.	-
» 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. The maximum length is 60 characters.	-
»» conceptAlias	string	true	The alias of the concept in the context for the measure type.The maximum length is 1,000 characters.	-
» 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	Indicates the type of detail provided.	BOOLEAN, NUMERIC, RANGE
»» 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.	TRUE, FALSE
»» 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. The value must be greater than or equal to 0 and must have no more than 6 digits on either side of the decimal.	-
»»» unitDescription	string	false	A textual description of the unit measure. The maximum length is 1,000 characters.	-
»»» unit	object	false	The unit of measure for the numeric value.	-
»»»» contextId	string	true	The ID of the context for the unit of measure. The maximum length is 60 characters.	-
»»»» conceptAlias	string	true	The alias of the concept in the context for the unit of measure.The maximum length is 1,000 characters.	-
»» 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. The value must be greater than or equal to 0 and must have no more than 6 digits on either side of the decimal.	-
»»» low	number(double)	false	The inclusive lower boundary of the range, which can include a decimal. The value must be greater than or equal to 0 and must have no more than 6 digits on either side of the decimal.	-
»»» unitDescription	string	false	A textual description of the unit measure. The maximum length is 1,000 characters.	-
»»» unit	object	false	The unit of measure for the range values.	-
»»»» contextId	string	true	The ID of the context for the unit of measure. The maximum length is 60 characters.	-
»»»» conceptAlias	string	true	The alias of the concept in the context for the unit of measure.The maximum length is 1,000 characters.	-
targetGroups	[object]	false	Used instead of targets field to group targets. A group can have a name or be unnamed. Sequencing is maintained by the natural order and applicable for both targetGroups and targets levels. Both targets and TargetGroups shouldn’t be filled in the same request body.	-
» name	string	false	Maximum length is 1,000 characters.	-
» targets	[object]	true	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.	-
»» measureTypeDescription	string	false	A textual description of the measure type. The maximum length is 1,000 characters.	-
»» 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. The maximum length is 60 characters.	-
»»» conceptAlias	string	true	The alias of the concept in the context for the measure type.The maximum length is 1,000 characters.	-
»» 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	Indicates the type of detail provided.	BOOLEAN, NUMERIC, RANGE
»»» 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.	TRUE, FALSE
»»» 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. The value must be greater than or equal to 0 and must have no more than 6 digits on either side of the decimal.	-
»»»» unitDescription	string	false	A textual description of the unit measure. The maximum length is 1,000 characters.	-
»»»» unit	object	false	The unit of measure for the numeric value.	-
»»»»» contextId	string	true	The ID of the context for the unit of measure. The maximum length is 60 characters.	-
»»»»» conceptAlias	string	true	The alias of the concept in the context for the unit of measure.The maximum length is 1,000 characters.	-
»»» 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. The value must be greater than or equal to 0 and must have no more than 6 digits on either side of the decimal.	-
»»»» low	number(double)	false	The inclusive lower boundary of the range, which can include a decimal. The value must be greater than or equal to 0 and must have no more than 6 digits on either side of the decimal.	-
»»»» unitDescription	string	false	A textual description of the unit measure. The maximum length is 1,000 characters.	-
»»»» unit	object	false	The unit of measure for the range values.	-
»»»»» contextId	string	true	The ID of the context for the unit of measure. The maximum length is 60 characters.	-
»»»»» conceptAlias	string	true	The alias of the concept in the context for the unit of measure.The maximum length is 1,000 characters.	-

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.	-
» 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 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 health concern 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 health concern of this plan template.	-
»»» id	string	false	The ID of the activity definition.	-

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.	-
» 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 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 health concern 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 health concern of this plan template.	-
»»» id	string	false	The ID of the activity definition.	-

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.	-
updatedSourceEncounter	object	false	The encounter at which the care plan item is updated. Encounters are interactions between a patient and a provider for the purpose of providing care.	-
» id	string	true	The unique ID of the encounter for a patient in a data partition.	-
» dataPartitionId	string	true	The Health Data Intelligence data partition ID of the data source.	-

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

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

postMeasureSuggestionDefinitions

Name	Type	Required	Description	Accepted Values
population	object	true	The population that is referenced for the measure suggestion definition.	-
» id	string	true	The ID of the population.	-
program	object	true	The program that is referenced for the measure suggestion definition.	-
» id	string	true	The ID of the program.	-
» measure	object	true	The measure that is referenced for the program.	-
»» id	string	true	The ID of the measure.	-
»» outcome	string	true	Indicates the current state of the measure. Currently, the following outcomes are possible: `NOT_ACHIEVED`: Indicates that the measure is not successfully achieved. `MISSING_DATA`: Indicates that the measure is missing some data.	NOT_ACHIEVED, MISSING_DATA, ACHIEVED, EXCLUDED
status	string	true	Indicates the current state of the measure suggestion definition. Currently, the following statuses are possible: `ACTIVE`: Indicates that the measure suggestion definition is active. `INACTIVE`: Indicates that the measure suggestion definition is not active.	ACTIVE, INACTIVE
planDefinition	object	true	The plan definition that is referenced for the measure suggestion definition.	-
» id	string	true	The ID of the plan definition.	-
» type	string	true	Indicates the type of plan definition. Currently, only `ACTIVITY_DEFINITION` is possible. `ACTIVITY_DEFINITION` indicates that an activity definition acts as a template that can be referenced when creating an activity.	ACTIVITY_DEFINITION
planEntity	object	false	The planEntity that is referenced for the measure suggestion definition. If this entity is not provided, the default field values are used.	-
» action	string	true	Indicates the type of action that should be performed. Currently, the following actions are possible: `CREATE`: Indicates that a new entity should be created with the type specified in planDefinition. `UPDATE`: Indicates that an existing entity should be updated.	CREATE, UPDATE
» activity	object	true	No description	-
»» status	string	true	Indicates the status. Currently, the following statuses are possible: `PROPOSED` `ACCEPTED` `COMPLETED` `CANCELLED`	PROPOSED, ACCEPTED, COMPLETED, CANCELLED
programGroup	object	false	This parameter is now deprecated. This parameter is ignored and is not used for definition mapping.	-
» id	string	false	The ID of the program group.	-

MeasureSuggestionDefinitions

Name	Type	Required	Description	Accepted Values
items	[MeasureSuggestionDefinition]	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.	-

putMeasureSuggestionDefinitions

Name	Type	Required	Description	Accepted Values
population	object	true	The population that is referenced for the measure suggestion definition.	-
» id	string	true	The ID of the population.	-
program	object	true	The program that is referenced for the measure suggestion definition.	-
» id	string	true	The ID of the program.	-
» measure	object	true	The measure that is referenced for the program.	-
»» id	string	true	The ID of the measure.	-
»» outcome	string	true	Indicates the current state of the measure. Currently, the following outcomes are possible: `NOT_ACHIEVED`: Indicates that the measure is not successfully achieved. `MISSING_DATA`: Indicates that the measure is missing some data.	NOT_ACHIEVED, MISSING_DATA, ACHIEVED, EXCLUDED
status	string	true	Indicates the current state of the measure suggestion definition. Currently, the following statuses are possible: `ACTIVE`: Indicates that the measure suggestion definition is active. `INACTIVE`: Indicates that the measure suggestion definition is not active.	ACTIVE, INACTIVE
planDefinition	object	true	The plan definition that is referenced for the measure suggestion definition.	-
» id	string	true	The ID of the plan definition.	-
» type	string	true	Indicates the type of plan definition. Currently, only `ACTIVITY_DEFINITION` is possible. `ACTIVITY_DEFINITION` indicates that an activity definition acts as a template that can be referenced when creating an activity.	ACTIVITY_DEFINITION
planEntity	object	false	The planEntity that is referenced for the measure suggestion definition. If this entity is not provided, the default field values are used.	-
» action	string	true	Indicates the type of action that should be performed. Currently, the following actions are possible: `CREATE`: Indicates that a new entity should be created with the type specified in planDefinition. `UPDATE`: Indicates that an existing entity should be updated.	CREATE, UPDATE
» activity	object	true	No description	-
»» status	string	true	Indicates the status. Currently, the following statuses are possible: `PROPOSED` `ACCEPTED` `COMPLETED` `CANCELLED`	PROPOSED, ACCEPTED, COMPLETED, CANCELLED
programGroup	object	false	This parameter is now deprecated. This parameter is ignored and is not used for definition mapping.	-
» id	string	false	The ID of the program group.	-

MeasureSuggestionSets

Name	Type	Required	Description	Accepted Values
items	[MeasureSuggestionSet]	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.	-

postMeasureSuggestionSets

Name	Type	Required	Description	Accepted Values
name	string	true	The name of the measure suggestion set.	-
patients	[object]	true	A list of patient references.	-
» id	string	true	The ID of the Health Data Intelligence patient. See Patient ID lookup for more information.	-
status	string	true	The current status of the measure suggestion set. 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.	INACTIVE, ACTIVE

putMeasureSuggestionSets

Name	Type	Required	Description	Accepted Values
name	string	true	The name of the measure suggestion set.	-
patients	[object]	true	A list of patient references.	-
» id	string	true	The ID of the Health Data Intelligence patient. See Patient ID lookup for more information.	-
status	string	true	The current status of the measure suggestion set. 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.	INACTIVE, ACTIVE

ConsumerActivities

Name	Type	Required	Description	Accepted Values
items	[ConsumerActivity]	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.	-

BarrierDefinitions

Name	Type	Required	Description	Accepted Values
items	[BarrierDefinition]	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.	-

postBarrierDefinitions

Name	Type	Required	Description	Accepted Values
code	object	true	Describes the barrier. Includes a text description of the barrier and possibly a set of codings.	-
» text	string	true	A human-readable, potentially personalized description of the barrier. This field must be provided for every barrier.	-
» codings	[object]	false	A list of coding objects.	-
»» code	string	true	The unique ID of the code.	-
»» system	string	true	The ID of the coding system that gives meaning to the code.	-
status	string	true	The current status of the barrier 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.	INACTIVE, ACTIVE
concept	object	false	The most applicable concept to use for coding purposes when instantiating the defined barrier. Or, for searching purposes, the set of codes that are most applicable.	-
» contextId	string	true	The unique context ID defined in the ontology.	-
» conceptAlias	string	true	The text mnemonic defined in the ontology that identifies the concept in the context.	-

putBarrierDefinitions

Name	Type	Required	Description	Accepted Values
code	object	true	Describes the barrier. Includes a text description of the barrier and possibly a set of codings.	-
» text	string	true	A human-readable, potentially personalized description of the barrier. This field must be provided for every barrier.	-
» codings	[object]	false	A list of coding objects.	-
»» code	string	true	The unique ID of the code.	-
»» system	string	true	The ID of the coding system that gives meaning to the code.	-
status	string	true	The current status of the barrier 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.	INACTIVE, ACTIVE
concept	object	false	The most applicable concept to use for coding purposes when instantiating the defined barrier. Or, for searching purposes, the set of codes that are most applicable.	-
» contextId	string	true	The unique context ID defined in the ontology.	-
» conceptAlias	string	true	The text mnemonic defined in the ontology that identifies the concept in the context.	-

postPlanMigrationsConsumersConsumeridEncountersReverts

Name	Type	Required	Description	Accepted Values
encounters	[object]	true	List of encounters that require longitudinal plan data migrations to be reverted.	-
» secondaryEncounterId	string	true	The ID of the encounter that the longitudinal plan data will be migrated from. For a revert, longitudinal plan data identified for reversion will be copied to the secondary encounter and will be marked as inactive in the primary encounter.	-
» primaryEncounterId	string	true	The ID of the encounter that the longitudinal plan data will be migrated to. For a revert, longitudinal plan data identified for reversion will be copied to the secondary encounter and marked inactive for the primary encounter.	-
» dataPartitionId	string	true	The ID of the data partition.	-
createdBy	object	true	A representation of the individual who is requesting the revert.	-
» 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), a professional in the tenant’s organization (PERSONNEL), or a consumer (SUBJECT). See the following definitions: - SUBJECT: The individual is the consumer. When the type is SUBJECT, display, reference and ID are not required. - SYSTEM: - SYSTEM is used to identify a nonliving 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, SUBJECT
» display	string	false	A text 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.	-

postPlanMigrationsConsumersReverts

Name	Type	Required	Description	Accepted Values
consumers	[object]	true	List of consumers that require longitudinal plan data migrations to be reverted.	-
» secondaryConsumerId	string	true	The ID of the consumer that the longitudinal plan data will be migrated from. This consumer will stay active after migration and revert. For a revert, longitudinal plan data identified for reversion will be copied to the secondary consumer and will be marked as inactive in the primary consumer.	-
» primaryConsumerId	string	true	The ID of the consumer that the longitudinal plan data will be migrated to. This consumer will remain active after a migration and revert. For a revert, longitudinal plan data identified for reversion will be copied to the secondary consumer and marked inactive for the primary consumer.	-
createdBy	object	true	A representation of the individual who is requesting the revert.	-
» 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), a professional in the tenant’s organization (PERSONNEL), or a consumer (SUBJECT). See the following definitions: - SUBJECT: The individual is the consumer. When the type is SUBJECT, display, reference and ID are not required. - SYSTEM: - SYSTEM is used to identify a nonliving 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, SUBJECT
» display	string	false	A text 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.	-

postPlanMigrationsConsumersConsumeridEncountersMigrations

Name	Type	Required	Description	Accepted Values
encounters	[object]	true	List of encounters that require longitudinal plan data to be migrated.	-
» secondaryEncounterId	string	true	The ID of the encounter that the longitudinal plan data will be migrated from. For a revert, longitudinal plan data identified for reversion will be copied to the secondary encounter and will be marked as inactive in the primary encounter.	-
» primaryEncounterId	string	true	The ID of the encounter that the longitudinal plan data will be migrated to. For a revert, longitudinal plan data identified for reversion will be copied to the secondary encounter and marked inactive for the primary encounter.	-
» dataPartitionId	string	true	The ID of the data partition.	-
createdBy	object	true	A representation of the individual who is requesting the migration.	-
» 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), a professional in the tenant’s organization (PERSONNEL), or a consumer (SUBJECT). See the following definitions: - SUBJECT: The individual is the consumer. When the type is SUBJECT, display, reference and ID are not required. - SYSTEM: - SYSTEM is used to identify a nonliving 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, SUBJECT
» display	string	false	A text 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.	-

postPlanMigrationsConsumersMigrations

Name	Type	Required	Description	Accepted Values
consumers	[object]	true	List of consumers that require longitudinal plan data to be migrated.	-
» secondaryConsumerId	string	true	The ID of the consumer that the longitudinal plan data will be migrated from. This consumer will stay active after migration and revert. For a revert, longitudinal plan data identified for reversion will be copied to the secondary consumer and will be marked as inactive in the primary consumer.	-
» primaryConsumerId	string	true	The ID of the consumer that the longitudinal plan data will be migrated to. This consumer will remain active after a migration and revert. For a revert, longitudinal plan data identified for reversion will be copied to the secondary consumer and marked inactive for the primary consumer.	-
createdBy	object	true	A representation of the individual who is requesting the migration.	-
» 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), a professional in the tenant’s organization (PERSONNEL), or a consumer (SUBJECT). See the following definitions: - SUBJECT: The individual is the consumer. When the type is SUBJECT, display, reference and ID are not required. - SYSTEM: - SYSTEM is used to identify a nonliving 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, SUBJECT
» display	string	false	A text 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.	-

Extracts

Name	Type	Required	Description	Accepted Values
items	[Extract]	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.	-

postExtracts

Name	Type	Required	Description	Accepted Values
consumers	[string]	true	List of consumers that require longitudinal plan data to be extracted.	-
createdBy	object	true	A representation of the individual who is requesting the migration.	-
» 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), a professional in the tenant’s organization (PERSONNEL), or a consumer (SUBJECT). See the following definitions: - SUBJECT: The individual is the consumer. When the type is SUBJECT, display, reference and ID are not required. - SYSTEM: - SYSTEM is used to identify a nonliving 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, SUBJECT
» display	string	false	A text 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.	-

Outputs

Name	Type	Required	Description	Accepted Values
items	[Output]	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.	-

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

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

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

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

Longitudinal Plan API v1

Plan Templates

Retrieve a Single Apply Plan Template Status

Parameters

Response Statuses

Apply a Plan Template

Parameters

Response Statuses

Create a Plan Template

Parameters

Response Statuses

Response Headers

Retrieve a List of Plan Templates

Parameters

Response Statuses

Update a Plan Template

Parameters

Response Statuses

Response Headers

Retrieve a Single Plan Template

Parameters

Response Statuses

Response Headers

Consumer Template Items

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

Parameters

Response Statuses

Activities

Remove a Related Health Concern From an Activity

Parameters

Response Statuses

Relate a Health Concern to an Activity

Parameters

Response Statuses

Retrieve a List of Health Concerns for an Activity

Parameters

Response Statuses

Remove a Related Goal From an Activity

Parameters

Response Statuses

Relate a Goal to an Activity

Parameters

Response Statuses

Retrieve a List of Goals for an Activity

Parameters

Response Statuses

Update an Activity Note

Parameters

Response Statuses

Response Headers

Retrieve a Single Activity Note

Parameters

Response Statuses

Response Headers

Create an Activity Note

Parameters

Response Statuses

Response Headers

Retrieve a List of Activity Notes

Parameters

Response Statuses

Create an Activity Batch

Parameters

Response Statuses

Update an Activity

Parameters

Response Statuses

Response Headers

Retrieve a Single Activity

Parameters

Response Statuses

Response Headers

Create an Activity

Parameters

Response Statuses

Response Headers

Retrieve a List of Activities for a Consumer

Parameters

Response Statuses

Retrieve the Status History for an Activity