Health Concern API v1

The Health Concern API allows systems to interact with a patient’s physical, social, and emotional health concerns. Health concerns can also describe conditions such as pregnancy that affect a person’s health but are not necessarily assumed to have an overall negative impact. Health concerns are tracked and managed by one or more individuals and can be associated with other plan entities, such as goals and activities.

URL: https://cernerdemo.api.us-1.healtheintent.com/health-concern/v1

Health Concerns

A health concern is a health-related matter that is important or worrisome to a patient, family member, or health care provider. Health concerns can include but are not limited to the following types:

Conditions that the patient is actively managing. For example, diabetes.
Family dynamics or concerns that need to be managed. For example, domestic violence or the fear of losing a loved one.
Social factors that can impact the person’s health. For example, unemployment.

Health concerns are not always in perfect alignment with the list of problems documented on the patient’s chart. A patient who has entered hospice might have an ongoing condition that is not actively managed anymore. Due to this, the timeline and lifecycle of a health concern can vary from any underlying condition.

Comments and related information about health concerns can be described in notes. Health concern notes allow users to document additional context for a health concern in an unstructured format.

Note: When the API is in read-only mode, only GET requests are permitted.

Retrieve the Status History for a Health Concern


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/health-concern/v1/health-concerns/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/health-concern/v1/health-concerns/11e8591a4d5e569c8f673f9b3f4603ec/status-history \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "status": "RESOLVED",
      "startAt": "2017-12-28T10:36:21.456Z",
      "updatedBy": {
        "type": "SUBJECT",
        "reference": {
          "id": "d8454f2a-665c-49d4-87db-8c167feae10e"
        }
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/health-concern/v1/health-concerns/11e8591a4d5e569c8f673f9b3f4603e/status-history?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/health-concern/v1/health-concerns/11e8591a4d5e569c8f673f9b3f4603e/status-history?offset=0&limit=20"
}

GET /health-concerns/{healthConcernId}/status-history

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

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
healthConcernId	path	string	true	N/A	The unique ID of the health concern.	-
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 Health Concern	StatusHistories
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Update a Health Concern 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/health-concern/v1/health-concerns/11e8901b64b1ca0b9c300d1ad3125a48/notes/11e8bddf139d4249a2716780b49ba904', headers: headers, body: {"text":"Risk for unstable blood glucose levels related to changes in physical activity and inadequate blood glucose monitoring","updatedBy":{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}},"updatedSourceEncounter":{"id":"11e8901b64b1ca0b9c300d1ad3125a48","dataPartitionId":"4de3a1ab-5783-4e30-ba60-551ab1cf86fc"},"status":"ACTIVE"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/health-concern/v1/health-concerns/11e8901b64b1ca0b9c300d1ad3125a48/notes/11e8bddf139d4249a2716780b49ba904 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \ \
-H 'If-Match: [object Object]' \
-d {"text":"Risk for unstable blood glucose levels related to changes in physical activity and inadequate blood glucose monitoring","updatedBy":{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}},"updatedSourceEncounter":{"id":"11e8901b64b1ca0b9c300d1ad3125a48","dataPartitionId":"4de3a1ab-5783-4e30-ba60-551ab1cf86fc"},"status":"ACTIVE"}

{
  "id": "11e8901dafad94f7a9b701d255a00ad0",
  "text": "Risk for unstable blood glucose levels related to changes in physical activity and inadequate blood glucose monitoring",
  "status": "ACTIVE",
  "createdBy": {
    "type": "PERSONNEL",
    "reference": {
      "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
    }
  },
  "updatedBy": {
    "type": "PERSONNEL",
    "reference": {
      "id": "d8454f2a-665c-49d4-87db-8c167feae12e"
    }
  },
  "createdAt": "2017-12-28T10:36:21.456Z",
  "updatedAt": "2018-04-16T18:12:11.123Z",
  "version": 1
}

PUT /health-concerns/{healthConcernId}/notes/{noteId}

Updates a single health concern note.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
If-Match	header	string	true	N/A	The version of the health concern note resource to update.	-
healthConcernId	path	string	true	N/A	The unique ID of the health concern.	-
noteId	path	string	true	N/A	The unique ID of the health concern note.	-
body	body	putHealthConcernsHealthconcernidNotes	true	N/A	No description	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	Update a Health Concern Note	HealthConcernNote
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 specific version of the health concern note.

Retrieve a Single Health Concern 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/health-concern/v1/health-concerns/11e8901b64b1ca0b9c300d1ad3125a48/notes/11e8bddf139d4249a2716780b49ba904', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/health-concern/v1/health-concerns/11e8901b64b1ca0b9c300d1ad3125a48/notes/11e8bddf139d4249a2716780b49ba904 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "11e8901dafad94f7a9b701d255a00ad0",
  "text": "Risk for unstable blood glucose levels related to changes in physical activity and inadequate blood glucose monitoring",
  "status": "ACTIVE",
  "createdBy": {
    "type": "PERSONNEL",
    "reference": {
      "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
    }
  },
  "updatedBy": {
    "type": "PERSONNEL",
    "reference": {
      "id": "d8454f2a-665c-49d4-87db-8c167feae12e"
    }
  },
  "createdAt": "2017-12-28T10:36:21.456Z",
  "updatedAt": "2018-04-16T18:12:11.123Z",
  "version": 1
}

GET /health-concerns/{healthConcernId}/notes/{noteId}

Retrieves a single health concern note.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
healthConcernId	path	string	true	N/A	The unique ID of the health concern.	-
noteId	path	string	true	N/A	The unique ID of the health concern note.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	Retrieve a Single Health Concern Note	HealthConcernNote
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 specific version of the health concern note.

Retrieve a List of Health Concern 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/health-concern/v1/health-concerns/11e8901b64b1ca0b9c300d1ad3125a48/notes', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/health-concern/v1/health-concerns/11e8901b64b1ca0b9c300d1ad3125a48/notes \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "11e8901dafad94f7a9b701d255a00ad0",
      "text": "Risk for unstable blood glucose levels related to changes in physical activity and inadequate blood glucose monitoring",
      "status": "ACTIVE",
      "createdBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "updatedBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "d8454f2a-665c-49d4-87db-8c167feae12e"
        }
      },
      "createdAt": "2017-12-28T10:36:21.456Z",
      "updatedAt": "2018-04-16T18:12:11.123Z",
      "version": 1
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/health-concern/v1/health-concerns/d8454f2a-665c-49d4-87db-8c167feae11e/notes?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/health-concern/v1/health-concerns/d8454f2a-665c-49d4-87db-8c167feae11e/notes?offset=0&limit=20"
}

GET /health-concerns/{healthConcernId}/notes

Retrieves a list of health concern notes for a given health concern.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
healthConcernId	path	string	true	N/A	The unique ID of the health concern.	-
status	query	array[string]	false	N/A	Filters the list of notes by 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 Health Concern Notes	HealthConcernNotes
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Create a Health Concern 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/health-concern/v1/health-concerns/11e8901b64b1ca0b9c300d1ad3125a48/notes', headers: headers, body: {"text":"Risk for unstable blood glucose levels related to changes in physical activity and inadequate blood glucose monitoring","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/health-concern/v1/health-concerns/11e8901b64b1ca0b9c300d1ad3125a48/notes \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"text":"Risk for unstable blood glucose levels related to changes in physical activity and inadequate blood glucose monitoring","createdBy":{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}},"originatingSourceEncounter":{"id":"11e8901b64b1ca0b9c300d1ad3125a48","dataPartitionId":"4de3a1ab-5783-4e30-ba60-551ab1cf86fc"}}

{
  "id": "11e8901dafad94f7a9b701d255a00ad0",
  "text": "Risk for unstable blood glucose levels related to changes in physical activity and inadequate blood glucose monitoring",
  "status": "ACTIVE",
  "createdBy": {
    "type": "PERSONNEL",
    "reference": {
      "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
    }
  },
  "updatedBy": {
    "type": "PERSONNEL",
    "reference": {
      "id": "d8454f2a-665c-49d4-87db-8c167feae12e"
    }
  },
  "createdAt": "2017-12-28T10:36:21.456Z",
  "updatedAt": "2018-04-16T18:12:11.123Z",
  "version": 1
}

POST /health-concerns/{healthConcernId}/notes

Creates a health concern note for a given health concern.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
healthConcernId	path	string	true	N/A	The unique ID of the health concern.	-
body	body	postHealthConcernsHealthconcernidNotes	true	N/A	No description	-

Response Statuses

Status	Meaning	Description	Schema
201	Created	Create a Health Concern Note	HealthConcernNote
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 specific version of the health concern note.

Update a Health Concern




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/health-concern/v1/health-concerns/11e8901b64b1ca0b9c300d1ad3125a48', headers: headers, body: {"onset":"2015-01-02","abatement":"2019-01-02","statusReason":"Will has been diagnosed with Type 1 diabetes, and it is being actively managed.","expressedBy":{"display":"Arthur McCain","type":"RELATED_PERSON"},"status":"ACTIVE","code":{"text":"Type 1 Diabetes","codings":[{"code":"E10","system":"2.16.840.1.113883.6.90"},{"code":"190362004","system":"2.16.840.1.113883.6.96"}]},"updatedBy":{"type":"SUBJECT"},"updatedSourceEncounter":{"id":"08121f12-006f-55za-019d-12kdk23094uu7","dataPartitionId":"7gh3a1ab-5783-8012-ba60-551ab1cf81kk"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/health-concern/v1/health-concerns/11e8901b64b1ca0b9c300d1ad3125a48 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \ \
-H 'If-Match: [object Object]' \
-d {"onset":"2015-01-02","abatement":"2019-01-02","statusReason":"Will has been diagnosed with Type 1 diabetes, and it is being actively managed.","expressedBy":{"display":"Arthur McCain","type":"RELATED_PERSON"},"status":"ACTIVE","code":{"text":"Type 1 Diabetes","codings":[{"code":"E10","system":"2.16.840.1.113883.6.90"},{"code":"190362004","system":"2.16.840.1.113883.6.96"}]},"updatedBy":{"type":"SUBJECT"},"updatedSourceEncounter":{"id":"08121f12-006f-55za-019d-12kdk23094uu7","dataPartitionId":"7gh3a1ab-5783-8012-ba60-551ab1cf81kk"}}

{
  "id": "11e8901dafad94f7a9b701d255a00ad0",
  "consumer": {
    "id": "d8454f2a-665c-49d4-87db-8c167feae10e"
  },
  "onset": "2015-01-02",
  "abatement": "2019-01-02",
  "expressedBy": {
    "display": "Arthur McCain",
    "type": "RELATED_PERSON"
  },
  "status": "RESOLVED",
  "statusReason": "The health concern has been resolved.",
  "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"
      }
    ]
  },
  "createdBy": {
    "type": "PERSONNEL",
    "reference": {
      "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
    }
  },
  "createdAt": "2017-12-28T10:36:21.456Z",
  "updatedBy": {
    "type": "SUBJECT",
    "reference": {
      "id": "d8454f2a-665c-49d4-87db-8c167feae10e"
    }
  },
  "updatedAt": "2018-04-16T18:12:11.123Z",
  "healthConcernDefinition": {
    "id": "11e8901b64b1ca0b9c300d1ad3125a48",
    "text": "Diabetes Mellitus Type 1"
  },
  "originatingSourceEncounter": {
    "id": "09920f12-006f-44za-019d-12kdk23094ee1",
    "dataPartitionId": "4de3a1ab-5783-4e30-ba60-551ab1cf86fc"
  },
  "updatedSourceEncounter": {
    "id": "08121f12-006f-55za-019d-12kdk23094uu7",
    "dataPartitionId": "7gh3a1ab-5783-8012-ba60-551ab1cf81kk"
  },
  "version": 1,
  "sourcePlanTemplate": {
    "id": "11e8902c5fe1e3238afa990c2154a1a3"
  },
  "recentNotes": [
    {
      "text": "Patient has been advised to begin an exercise regimen.",
      "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": "Risk for unstable blood glucose levels related to changes in physical activity and inadequate blood glucose monitoring.",
      "id": "22e8998c12b3bb9ebd7c1fbb695d35fd",
      "status": "ACTIVE",
      "createdBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "createdAt": "2017-11-28T10:36:21.456Z",
      "updatedBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "updatedAt": "2018-03-16T18:12:11.123Z"
    }
  ],
  "statusHistory": [
    {
      "status": "RESOLVED",
      "startAt": "2017-12-28T10:36:21.456Z",
      "updatedBy": {
        "type": "SUBJECT",
        "reference": {
          "id": "d8454f2a-665c-49d4-87db-8c167feae10e"
        }
      }
    }
  ]
}

PUT /health-concerns/{healthConcernId}

Updates a health concern.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
If-Match	header	string	true	N/A	The version of the health concern resource to update.	-
healthConcernId	path	string	true	N/A	The unique ID of the health concern.	-
body	body	putHealthConcerns	true	N/A	No description	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	Update a Health Concern	HealthConcernEntity
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
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 specific version of the health concern.

Retrieve a Single Health Concern


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/health-concern/v1/health-concerns/11e8901b64b1ca0b9c300d1ad3125a48', headers: headers)

print JSON.pretty_generate(result)


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

{
  "id": "11e8901dafad94f7a9b701d255a00ad0",
  "consumer": {
    "id": "d8454f2a-665c-49d4-87db-8c167feae10e"
  },
  "onset": "2015-01-02",
  "abatement": "2019-01-02",
  "expressedBy": {
    "display": "Arthur McCain",
    "type": "RELATED_PERSON"
  },
  "status": "RESOLVED",
  "statusReason": "The health concern has been resolved.",
  "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"
      }
    ]
  },
  "createdBy": {
    "type": "PERSONNEL",
    "reference": {
      "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
    }
  },
  "createdAt": "2017-12-28T10:36:21.456Z",
  "updatedBy": {
    "type": "SUBJECT",
    "reference": {
      "id": "d8454f2a-665c-49d4-87db-8c167feae10e"
    }
  },
  "updatedAt": "2018-04-16T18:12:11.123Z",
  "healthConcernDefinition": {
    "id": "11e8901b64b1ca0b9c300d1ad3125a48",
    "text": "Diabetes Mellitus Type 1"
  },
  "originatingSourceEncounter": {
    "id": "09920f12-006f-44za-019d-12kdk23094ee1",
    "dataPartitionId": "4de3a1ab-5783-4e30-ba60-551ab1cf86fc"
  },
  "updatedSourceEncounter": {
    "id": "08121f12-006f-55za-019d-12kdk23094uu7",
    "dataPartitionId": "7gh3a1ab-5783-8012-ba60-551ab1cf81kk"
  },
  "version": 1,
  "sourcePlanTemplate": {
    "id": "11e8902c5fe1e3238afa990c2154a1a3"
  },
  "recentNotes": [
    {
      "text": "Patient has been advised to begin an exercise regimen.",
      "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": "Risk for unstable blood glucose levels related to changes in physical activity and inadequate blood glucose monitoring.",
      "id": "22e8998c12b3bb9ebd7c1fbb695d35fd",
      "status": "ACTIVE",
      "createdBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "createdAt": "2017-11-28T10:36:21.456Z",
      "updatedBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "updatedAt": "2018-03-16T18:12:11.123Z"
    }
  ],
  "statusHistory": [
    {
      "status": "RESOLVED",
      "startAt": "2017-12-28T10:36:21.456Z",
      "updatedBy": {
        "type": "SUBJECT",
        "reference": {
          "id": "d8454f2a-665c-49d4-87db-8c167feae10e"
        }
      }
    }
  ]
}

GET /health-concerns/{healthConcernId}

Retrieves a single health concern.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
healthConcernId	path	string	true	N/A	The unique ID of the health concern.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	Retrieve a Single Health Concern	HealthConcernEntity
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 specific version of the health concern.

Create a Health Concern 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/health-concern/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/health-concerns/batch', headers: headers, body: {"healthConcerns":[{"healthConcernDefinitionId":"11e8902c9e2908c69718f13503066bee","status":"ACTIVE"},{"healthConcernDefinitionId":"12e1902c0e3118c05719g13503006wee","status":"PROPOSED"}],"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/health-concern/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/health-concerns/batch \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"healthConcerns":[{"healthConcernDefinitionId":"11e8902c9e2908c69718f13503066bee","status":"ACTIVE"},{"healthConcernDefinitionId":"12e1902c0e3118c05719g13503006wee","status":"PROPOSED"}],"createdBy":{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}},"originatingSourceEncounter":{"id":"11e8901b64b1ca0b9c300d1ad3125a48","dataPartitionId":"4de3a1ab-5783-4e30-ba60-551ab1cf86fc"}}

{
  "items": [
    {
      "id": "11e8901dafad94f7a9b701d255a00ad0",
      "consumer": {
        "id": "d8454f2a-665c-49d4-87db-8c167feae10e"
      },
      "onset": "2015-01-02",
      "abatement": "2019-01-02",
      "expressedBy": {
        "display": "Arthur McCain",
        "type": "RELATED_PERSON"
      },
      "status": "RESOLVED",
      "statusReason": "The health concern has been resolved.",
      "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"
          }
        ]
      },
      "createdBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "createdAt": "2017-12-28T10:36:21.456Z",
      "updatedBy": {
        "type": "SUBJECT",
        "reference": {
          "id": "d8454f2a-665c-49d4-87db-8c167feae10e"
        }
      },
      "updatedAt": "2018-04-16T18:12:11.123Z",
      "healthConcernDefinition": {
        "id": "11e8901b64b1ca0b9c300d1ad3125a48",
        "text": "Diabetes Mellitus Type 1"
      },
      "originatingSourceEncounter": {
        "id": "09920f12-006f-44za-019d-12kdk23094ee1",
        "dataPartitionId": "4de3a1ab-5783-4e30-ba60-551ab1cf86fc"
      },
      "updatedSourceEncounter": {
        "id": "08121f12-006f-55za-019d-12kdk23094uu7",
        "dataPartitionId": "7gh3a1ab-5783-8012-ba60-551ab1cf81kk"
      },
      "version": 1,
      "sourcePlanTemplate": {
        "id": "11e8902c5fe1e3238afa990c2154a1a3"
      },
      "recentNotes": [
        {
          "text": "Patient has been advised to begin an exercise regimen.",
          "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": "Risk for unstable blood glucose levels related to changes in physical activity and inadequate blood glucose monitoring.",
          "id": "22e8998c12b3bb9ebd7c1fbb695d35fd",
          "status": "ACTIVE",
          "createdBy": {
            "type": "PERSONNEL",
            "reference": {
              "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
            }
          },
          "createdAt": "2017-11-28T10:36:21.456Z",
          "updatedBy": {
            "type": "PERSONNEL",
            "reference": {
              "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
            }
          },
          "updatedAt": "2018-03-16T18:12:11.123Z"
        }
      ],
      "statusHistory": [
        {
          "status": "RESOLVED",
          "startAt": "2017-12-28T10:36:21.456Z",
          "updatedBy": {
            "type": "SUBJECT",
            "reference": {
              "id": "d8454f2a-665c-49d4-87db-8c167feae10e"
            }
          }
        }
      ]
    }
  ],
  "totalResults": 1
}

POST /consumers/{consumerId}/health-concerns/batch

Creates a batch of health concerns. A maximum of 20 health concerns can be created.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
201	Created	Create a Health Concern Batch	HealthConcernBatchList
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
415	Unsupported Media Type	Unsupported Media Type	Error

Retrieve a List of Health Concerns


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/health-concern/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/health-concerns', headers: headers)

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "11e8901dafad94f7a9b701d255a00ad0",
      "consumer": {
        "id": "d8454f2a-665c-49d4-87db-8c167feae10e"
      },
      "onset": "2015-01-02",
      "abatement": "2019-01-02",
      "expressedBy": {
        "display": "Arthur McCain",
        "type": "RELATED_PERSON"
      },
      "status": "RESOLVED",
      "statusReason": "The health concern has been resolved.",
      "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"
          }
        ]
      },
      "createdBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "createdAt": "2017-12-28T10:36:21.456Z",
      "updatedBy": {
        "type": "SUBJECT",
        "reference": {
          "id": "d8454f2a-665c-49d4-87db-8c167feae10e"
        }
      },
      "updatedAt": "2018-04-16T18:12:11.123Z",
      "healthConcernDefinition": {
        "id": "11e8901b64b1ca0b9c300d1ad3125a48",
        "text": "Diabetes Mellitus Type 1"
      },
      "originatingSourceEncounter": {
        "id": "09920f12-006f-44za-019d-12kdk23094ee1",
        "dataPartitionId": "4de3a1ab-5783-4e30-ba60-551ab1cf86fc"
      },
      "updatedSourceEncounter": {
        "id": "08121f12-006f-55za-019d-12kdk23094uu7",
        "dataPartitionId": "7gh3a1ab-5783-8012-ba60-551ab1cf81kk"
      },
      "version": 1,
      "sourcePlanTemplate": {
        "id": "11e8902c5fe1e3238afa990c2154a1a3"
      },
      "recentNotes": [
        {
          "text": "Patient has been advised to begin an exercise regimen.",
          "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": "Risk for unstable blood glucose levels related to changes in physical activity and inadequate blood glucose monitoring.",
          "id": "22e8998c12b3bb9ebd7c1fbb695d35fd",
          "status": "ACTIVE",
          "createdBy": {
            "type": "PERSONNEL",
            "reference": {
              "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
            }
          },
          "createdAt": "2017-11-28T10:36:21.456Z",
          "updatedBy": {
            "type": "PERSONNEL",
            "reference": {
              "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
            }
          },
          "updatedAt": "2018-03-16T18:12:11.123Z"
        }
      ],
      "statusHistory": [
        {
          "status": "RESOLVED",
          "startAt": "2017-12-28T10:36:21.456Z",
          "updatedBy": {
            "type": "SUBJECT",
            "reference": {
              "id": "d8454f2a-665c-49d4-87db-8c167feae10e"
            }
          }
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/health-concern/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/health-concerns?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/health-concern/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/health-concerns?offset=0&limit=20"
}

GET /consumers/{consumerId}/health-concerns

Retrieves a list of health concerns for a given consumer. The list is primarily sorted by text in ascending alphabetic order and secondarily sorted by onset date in reverse chronological order.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
status	query	array[string]	false	N/A	Filters the list of health concerns by status. The following statuses are possible for health concerns: - ACTIVE: Indicates that signs or symptoms of the health concern are currently evident. - IN_ERROR: Indicates that the health concern was mistakenly identified. - 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 patient is no longer experiencing symptoms of the health concern or that evidence of the health concern no longer exists.	IN_ERROR, ACTIVE, RELAPSE, REMISSION, RESOLVED, INACTIVE, PROPOSED, ACCEPTED, REJECTED
id	query	array[string]	false	N/A	The unique IDs of the health concerns.	-
healthConcernDefinitionId	query	array[string]	false	N/A	The unique IDs of different health concern definitions.	-
consumerId	path	string	true	N/A	The unique ID of a Oracle Health Data Intelligence consumer. See Consumer API for more information.	-
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	HealthConcernEntities
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a Health Concern




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/health-concern/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/health-concerns', headers: headers, body: {"onset":"2015-01-02","abatement":"2019-01-02","statusReason":"Will has been diagnosed with Type 1 diabetes, and it is being actively managed.","expressedBy":{"display":"Arthur McCain","type":"RELATED_PERSON"},"status":"ACTIVE","code":{"text":"Type 1 Diabetes","codings":[{"code":"E10","system":"2.16.840.1.113883.6.90"},{"code":"190362004","system":"2.16.840.1.113883.6.96"}]},"createdBy":{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}},"healthConcernDefinition":{"id":"11e8901b64b1ca0b9c300d1ad3125a48"},"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/health-concern/v1/consumers/d8454f2a-665c-49d4-87db-8c167feae10e/health-concerns \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"onset":"2015-01-02","abatement":"2019-01-02","statusReason":"Will has been diagnosed with Type 1 diabetes, and it is being actively managed.","expressedBy":{"display":"Arthur McCain","type":"RELATED_PERSON"},"status":"ACTIVE","code":{"text":"Type 1 Diabetes","codings":[{"code":"E10","system":"2.16.840.1.113883.6.90"},{"code":"190362004","system":"2.16.840.1.113883.6.96"}]},"createdBy":{"type":"PERSONNEL","reference":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}},"healthConcernDefinition":{"id":"11e8901b64b1ca0b9c300d1ad3125a48"},"originatingSourceEncounter":{"id":"11e8901b64b1ca0b9c300d1ad3125a48","dataPartitionId":"4de3a1ab-5783-4e30-ba60-551ab1cf86fc"},"sourcePlanTemplate":{"id":"11e8902c5fe1e3238afa990c2154a1a3"}}

{
  "id": "11e8901dafad94f7a9b701d255a00ad0",
  "consumer": {
    "id": "d8454f2a-665c-49d4-87db-8c167feae10e"
  },
  "onset": "2015-01-02",
  "abatement": "2019-01-02",
  "expressedBy": {
    "display": "Arthur McCain",
    "type": "RELATED_PERSON"
  },
  "status": "RESOLVED",
  "statusReason": "The health concern has been resolved.",
  "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"
      }
    ]
  },
  "createdBy": {
    "type": "PERSONNEL",
    "reference": {
      "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
    }
  },
  "createdAt": "2017-12-28T10:36:21.456Z",
  "updatedBy": {
    "type": "SUBJECT",
    "reference": {
      "id": "d8454f2a-665c-49d4-87db-8c167feae10e"
    }
  },
  "updatedAt": "2018-04-16T18:12:11.123Z",
  "healthConcernDefinition": {
    "id": "11e8901b64b1ca0b9c300d1ad3125a48",
    "text": "Diabetes Mellitus Type 1"
  },
  "originatingSourceEncounter": {
    "id": "09920f12-006f-44za-019d-12kdk23094ee1",
    "dataPartitionId": "4de3a1ab-5783-4e30-ba60-551ab1cf86fc"
  },
  "updatedSourceEncounter": {
    "id": "08121f12-006f-55za-019d-12kdk23094uu7",
    "dataPartitionId": "7gh3a1ab-5783-8012-ba60-551ab1cf81kk"
  },
  "version": 1,
  "sourcePlanTemplate": {
    "id": "11e8902c5fe1e3238afa990c2154a1a3"
  },
  "recentNotes": [
    {
      "text": "Patient has been advised to begin an exercise regimen.",
      "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": "Risk for unstable blood glucose levels related to changes in physical activity and inadequate blood glucose monitoring.",
      "id": "22e8998c12b3bb9ebd7c1fbb695d35fd",
      "status": "ACTIVE",
      "createdBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "createdAt": "2017-11-28T10:36:21.456Z",
      "updatedBy": {
        "type": "PERSONNEL",
        "reference": {
          "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
        }
      },
      "updatedAt": "2018-03-16T18:12:11.123Z"
    }
  ],
  "statusHistory": [
    {
      "status": "RESOLVED",
      "startAt": "2017-12-28T10:36:21.456Z",
      "updatedBy": {
        "type": "SUBJECT",
        "reference": {
          "id": "d8454f2a-665c-49d4-87db-8c167feae10e"
        }
      }
    }
  ]
}

POST /consumers/{consumerId}/health-concerns

Creates a health concern for a consumer.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
201	Created	Create a Health Concern	HealthConcernEntity
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
415	Unsupported Media Type	Unsupported Media Type	Error

Response Headers

Status	Header	Type	Format	Description
201	ETag	string		The specific version of the health concern.

Health Concern Definitions

A health concern definition provides a means of documenting a health concern based on a set of codes from a specific code system. Health concern definitions act as templates that can be referenced when creating a health concern. The set of health concern definitions form a catalog of content that can be searched, selected, and customized when first establishing a health concern for an individual.

Create a Health Concern 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/health-concern/v1/health-concern-definitions', headers: headers, body: {"text":"Diabetes Mellitus Type 1","status":"ACTIVE","concept":{"contextId":"37686A3F9C66452ABA66803ECC144344","alias":"DEPRESSION_SCREEN_POSITIVE_WITH_INTERVENTION_CLIN"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/health-concern/v1/health-concern-definitions \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"text":"Diabetes Mellitus Type 1","status":"ACTIVE","concept":{"contextId":"37686A3F9C66452ABA66803ECC144344","alias":"DEPRESSION_SCREEN_POSITIVE_WITH_INTERVENTION_CLIN"}}

{
  "id": "11e8901b64b1ca0b9c300d1ad3125a48",
  "text": "Diabetes Mellitus Type 1",
  "status": "ACTIVE",
  "createdAt": "2018-04-20T15:27:47.123Z",
  "updatedAt": "2018-04-20T15:27:47.123Z",
  "concept": {
    "contextId": "37686A3F9C66452ABA66803ECC144344",
    "alias": "DEPRESSION_SCREEN_POSITIVE_WITH_INTERVENTION_CLIN"
  }
}

POST /health-concern-definitions

Creates a health concern definition.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
201	Created	Create a Health Concern Definition	HealthConcernDefinition
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 specific version of the health concern definition.

Retrieve a List of Health Concern 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/health-concern/v1/health-concern-definitions', headers: headers)

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "11e8901b64b1ca0b9c300d1ad3125a48",
      "text": "Diabetes Mellitus Type 1",
      "status": "ACTIVE",
      "createdAt": "2018-04-20T15:27:47.123Z",
      "updatedAt": "2018-04-20T15:27:47.123Z",
      "concept": {
        "contextId": "37686A3F9C66452ABA66803ECC144344",
        "alias": "DEPRESSION_SCREEN_POSITIVE_WITH_INTERVENTION_CLIN"
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/health-concern/v1/health-concern-definitions?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/health-concern/v1/health-concern-definitions?offset=0&limit=20"
}

GET /health-concern-definitions

Retrieves a list of health concern definitions.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
status	query	array[string]	false	N/A	Filters the list of health concern definitions by status.	ACTIVE, INACTIVE
text	query	string	false	N/A	Filters the list of health concern definitions by the specified text.	-
id	query	array[string]	false	N/A	When present, the unique ID of the health concern definition must match the provided value.	-
concept	query	array[string]	false	N/A	Filters the list of health concern definitions by a list of concepts. The concept is a composite ID that consists of the context ID and concept alias separated by a pipe character.	-
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 Concern Definitions	HealthConcernDefinitions
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Update a Health Concern 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/health-concern/v1/health-concern-definitions/11e8901b64b1ca0b9c300d1ad3125a48', headers: headers, body: {"text":"Diabetes Mellitus Type 1","status":"ACTIVE","concept":{"contextId":"37686A3F9C66452ABA66803ECC144344","alias":"DEPRESSION_SCREEN_POSITIVE_WITH_INTERVENTION_CLIN"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/health-concern/v1/health-concern-definitions/11e8901b64b1ca0b9c300d1ad3125a48 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \ \
-H 'If-Match: [object Object]' \
-d {"text":"Diabetes Mellitus Type 1","status":"ACTIVE","concept":{"contextId":"37686A3F9C66452ABA66803ECC144344","alias":"DEPRESSION_SCREEN_POSITIVE_WITH_INTERVENTION_CLIN"}}

{
  "id": "11e8901b64b1ca0b9c300d1ad3125a48",
  "text": "Diabetes Mellitus Type 1",
  "status": "ACTIVE",
  "createdAt": "2018-04-20T15:27:47.123Z",
  "updatedAt": "2018-04-20T15:27:47.123Z",
  "concept": {
    "contextId": "37686A3F9C66452ABA66803ECC144344",
    "alias": "DEPRESSION_SCREEN_POSITIVE_WITH_INTERVENTION_CLIN"
  }
}

PUT /health-concern-definitions/{healthConcernDefinitionId}

Updates a health concern definition.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
If-Match	header	string	true	N/A	The version of the health concern definition resource to update.	-
healthConcernDefinitionId	path	string	true	N/A	The unique ID of the health concern definition.	-
body	body	putHealthConcernDefinitions	true	N/A	No description	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	Update a Health Concern Definition	HealthConcernDefinition
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 specific version of the health concern definition.

Retrieve a Single Health Concern 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/health-concern/v1/health-concern-definitions/11e8901b64b1ca0b9c300d1ad3125a48', headers: headers)

print JSON.pretty_generate(result)


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

{
  "id": "11e8901b64b1ca0b9c300d1ad3125a48",
  "text": "Diabetes Mellitus Type 1",
  "status": "ACTIVE",
  "createdAt": "2018-04-20T15:27:47.123Z",
  "updatedAt": "2018-04-20T15:27:47.123Z",
  "concept": {
    "contextId": "37686A3F9C66452ABA66803ECC144344",
    "alias": "DEPRESSION_SCREEN_POSITIVE_WITH_INTERVENTION_CLIN"
  }
}

GET /health-concern-definitions/{healthConcernDefinitionId}

Retrieves a single health concern definition by ID.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
healthConcernDefinitionId	path	string	true	N/A	The unique ID of the health concern definition.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	Retrieve a Single Health Concern Definition	HealthConcernDefinition
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 specific version of the health concern definition.

Health Concern Definition Contexts

Health concern definition contexts can be used to search for health concern definitions by codes. When a request is sent for a certain code, the ontological health concern definition context to which the code belongs is retrieved. See Ontology API for more information about ontological contexts.

Retrieve a List of Health Concern Definition Contexts


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/health-concern/v1/health-concern-definition-contexts', headers: headers)

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "11e8901b64b1ca0b9c300d1ad3125a48"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/health-concern/v1/health-concern-definition-contexts?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/health-concern/v1/health-concern-definition-contexts?offset=0&limit=20"
}

GET /health-concern-definition-contexts

Retrieves a list of health concern definition contexts.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
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 Concern Definition Contexts	HealthConcernDefinitionContexts
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Delete a Health Concern Definition Context


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/health-concern/v1/health-concern-definition-contexts/11e8901b64b1ca0b9c300d1ad3125a48', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/health-concern/v1/health-concern-definition-contexts/11e8901b64b1ca0b9c300d1ad3125a48 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /health-concern-definition-contexts/{healthConcernDefinitionContextId}

Deletes a health concern definition context.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
healthConcernDefinitionContextId	path	string	true	N/A	No description	-

Response Statuses

Status	Meaning	Description	Schema
204	No Content	The health concern definition context was deleted.	HealthConcernDefinitionContext
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Create a Health Concern Definition Context


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/health-concern/v1/health-concern-definition-contexts/11e8901b64b1ca0b9c300d1ad3125a48', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/health-concern/v1/health-concern-definition-contexts/11e8901b64b1ca0b9c300d1ad3125a48 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

PUT /health-concern-definition-contexts/{healthConcernDefinitionContextId}

Creates a health concern definition context.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
healthConcernDefinitionContextId	path	string	true	N/A	No description	-

Response Statuses

Status	Meaning	Description	Schema
204	No Content	The health concern definition context was created.	HealthConcernDefinitionContext
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Schema Definitions

Code

Name	Type	Required	Description	Accepted Values
display	string	false	The display value of a code in a coding 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.	-

CodeableConcept

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.	-
codings	[Code]	false	A list of codified values from a standard code system.	-

Concept

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

HealthConcernBatchList

Name	Type	Required	Description	Accepted Values
items	[HealthConcernEntity]	false	A list of health concerns to be created in the batch endpoint.	-
totalResults	integer(int32)	true	The total results in the response after the POST call. This depends on the number of results in the request body of the POST call.	-

HealthConcernEntity

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the health concern	-
consumer	Reference	true	The consumer with which the health concern is associated.	-
onset	string	false	The estimated or actual date when the health concern began. In ISO formatting with precision ranging from YYYY to YYYY-MM-DD. This range of precision is allowed to support approximate onset dates, for example, 2017 for sometime in 2017, 2017-01 for sometime in January 2017, or 2017-01-01 for January 1, 2017. The onset of the health concern may not always align with that of the underlying problem or condition. For example, a person may be diagnosed with a condition for a period of time but that condition may not be raised to the level of a concern that needs to be actively managed until a later date.	-
abatement	string	false	The estimated or actual date when the health concern was resolved or went into remission. In ISO 8601 formatting with precision ranging from YYYY to YYYY-MM-DD. This range of precision is allowed to support approximate abatement time ranges, for example, 2017 for sometime in 2017, 2017-01 for sometime in January 2017, or 2017-01-01 for January 1, 2017. The abatement of a health concern may not always align with that of the underlying condition or problem. For example, a health concern may be abated when a person begins hospice care because it is no longer of concern to the person or their care team even though the condition may not be resolved.	-
expressedBy	Individual	false	The individual who expresses the concern	-
status	string	true	The current status of the health concern. The following statuses are possible: - ACTIVE: Indicates that signs or symptoms of the health concern are currently evident. - IN_ERROR: Indicates that the health concern was mistakenly identified. - 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. - PROPOSED: Indicates that the health concern was proposed. - ACCEPTED: Indicates that the health concern was accepted or acknowledged. - REJECTED: Indicates that the health concern was rejected.	IN_ERROR, ACTIVE, RELAPSE, REMISSION, RESOLVED, INACTIVE, PROPOSED, ACCEPTED, REJECTED
statusReason	string	false	A textual representation of the reason the health concern is in its current status.	-
code	CodeableConcept	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. Once the health concern is created, codings associated with it cannot be changed.	-
createdBy	User	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.	-
updatedBy	User	true	The individual who last modified the health concern in the system. When the health concern is first created, the value in ‘updatedBy’ is set by the service to match the ‘createdBy’ field.	-
updatedAt	string	true	The date and time when the health concern 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 health concern is modified; therefore, the field does not need to be set explicitly. When the health concern is first created, the value in ‘updatedAt’ is set by the service to match the value in the ‘createdAt’ field.	-
healthConcernDefinition	HealthConcernDefinitionReference	false	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.	-
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 health concern. 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.	-
sourcePlanTemplate	PlanTemplateReference	false	The source plan template that was referenced when the health concern was first created. This field is immutable and can be set only when the health concern is initially created.	-
recentNotes	[HealthConcernNote]	false	A list of recently created active notes for a health concern. The notes are sorted by created date and time in descending order. A maximum of two recently created active notes are retrieved.	-
statusHistory	[StatusHistory]	true	A list of statuses that have been applied to the health concern. The statuses are sorted by start date and time in descending order. A maximum of two statuses are retrieved.	-

Reference

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

Individual

Name	Type	Required	Description	Accepted Values
type	string	true	Describes the role the individual plays in relation to the health concern. Currently, the individual expressing the health concern can be the focus of the concern (SUBJECT), a medical professional in the tenant organization (PERSONNEL), or a person related to the focus of the health concern (RELATED_PERSON).	PERSONNEL, SUBJECT, RELATED_PERSON
reference	Reference	false	A reference to the individual who expressed the health concern. If reference is provided, the type must be PERSONNEL and the display cannot be provided.	-
display	string	false	A textual display that identifies the individual being defined. If display is provided, the type must be RELATED_PERSON or PERSONNEL and reference cannot be provided.	-

User

Name	Type	Required	Description	Accepted Values
type	string	true	Describes 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 reference is provided, the type must be PERSONNEL	-

HealthConcernDefinitionReference

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

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

PlanTemplateReference

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

HealthConcernNote

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the health concern note	-
text	string	true	A textual description of the health concern note. The maximum length is 32,000 characters.	-
status	string	true	The current status of the health concern note.	ACTIVE, IN_ERROR
createdBy	NoteActor	true	The individual who created the health concern note in the system	-
updatedBy	NoteActor	true	The individual who last modified the health concern note in the system.	-
createdAt	string	true	The date and time when the health concern note 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 note is first created; therefore, the field does not need to be set explicitly.	-
updatedAt	string	true	The date and time when the health concern note 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 health concern note is modified; therefore, the field does not need to be set explicitly. When the health concern note is first created, the value in ‘updatedAt’ is set by the service to match the value in the ‘createdAt’ field.	-
version	integer(int32)	true	The current version of the health concern. 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.	-

NoteActor

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 can be only a professional in the tenant’s organization (PERSONNEL). - PERSONNEL - The individual is a medical professional who is part of the tenant’s organization. When this type is used, a reference to the professional’s entry in the personnel service is provided. When type is PERSONNEL, id is required.	PERSONNEL
reference	Reference	true	A reference to the individual. If reference is provided, the type must be PERSONNEL	-

StatusHistory

Name	Type	Required	Description	Accepted Values
status	string	true	The status of the health concern. The following statuses are possible: - ACTIVE: Indicates that signs or symptoms of the health concern are currently evident. - IN_ERROR: Indicates that the health concern was mistakenly identified. - 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. - PROPOSED: Indicates that the health concern was proposed. - ACCEPTED: Indicates that the health concern was accepted or acknowledged. - REJECTED: Indicates that the health concern was rejected.	IN_ERROR, ACTIVE, RELAPSE, REMISSION, RESOLVED, INACTIVE, PROPOSED, ACCEPTED, REJECTED
startAt	string	true	The date the status was applied to the health concern, in International Organization for Standardization (ISO) 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-
endAt	string	false	The date the status was removed from the health concern, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-
updatedBy	User	true	The individual who modified the status of the health concern.	-

HealthConcernDefinitionContext

Name	Type	Required	Description	Accepted Values
id	string	false	The unique ID of the health concern definition context.	-

HealthConcernDefinition

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the health concern definition.	-
text	string	true	A textual description of the health concern definition.	-
status	string	true	The current status of the health concern definition.	ACTIVE, INACTIVE
createdAt	string	true	The date and time when the health concern 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 health concern definition is first created; therefore, the field does not need to be set explicitly.	-
updatedAt	string	true	The date and time when the health concern 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 health concern definition is modified; therefore, the field does not need to be set explicitly. When the health concern definition is first created, the value in ‘updatedAt’ is set by the service to match the value in the ‘createdAt’ field.	-
concept	Concept	false	The most applicable concept to use for coding purposes when instantiating the defined health concern. Or, for searching purposes, the set of codes that are most applicable.	-

StatusHistories

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

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

putHealthConcernsHealthconcernidNotes

Name	Type	Required	Description	Accepted Values
text	string	true	A textual description of the health concern note. The maximum length is 32,000 characters.	-
updatedBy	object	true	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 to match the ‘createdBy’ field.	-
» type	string	true	An enumerated list that describes the role the individual plays in relation to the entity. Currently, it can be only a professional in the tenant’s organization (PERSONNEL). - PERSONNEL - The individual is a medical professional who is part of the tenant’s organization. When this type is used, a reference to the professional’s entry in the personnel service is provided. When type is PERSONNEL, id is required.	PERSONNEL
» reference	object	false	A reference to the individual. If reference is provided, the type must be PERSONNEL.	-
»» id	string	true	The unique 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.	-
status	string	true	The current status of the health concern note.	ACTIVE, IN_ERROR

HealthConcernNotes

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

postHealthConcernsHealthconcernidNotes

Name	Type	Required	Description	Accepted Values
text	string	true	A textual description of the health concern note. The maximum length is 32,000 characters.	-
createdBy	object	true	The individual who created the note in the system.	-
» type	string	true	An enumerated list that describes the role the individual plays in relation to the entity. Currently, it can be only a professional in the tenant’s organization (PERSONNEL). - PERSONNEL - The individual is a medical professional who is part of the tenant’s organization. When this type is used, a reference to the professional’s entry in the personnel service is provided. When type is PERSONNEL, id is required.	PERSONNEL
» reference	object	false	A reference to the individual. If reference is provided, the type must be PERSONNEL.	-
»» id	string	true	The unique 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.	-

putHealthConcerns

Name	Type	Required	Description	Accepted Values
onset	string	false	The estimated or actual date when the health concern began. In ISO formatting with precision ranging from YYYY to YYYY-MM-DD. This range of precision is allowed to support approximate onset dates, for example, 2017 for sometime in 2017, 2017-01 for sometime in January 2017, or 2017-01-01 for January 1, 2017. The onset of the health concern may not always align with that of the underlying problem or condition. For example, a person may be diagnosed with a condition for a period of time but that condition may not be raised to the level of a concern that needs to be actively managed until a later date.	-
abatement	string	false	The estimated or actual date when the health concern was resolved or went into remission. In ISO 8601 formatting with precision ranging from YYYY to YYYY-MM-DD. This range of precision is allowed to support approximate abatement time ranges, for example, 2017 for sometime in 2017, 2017-01 for sometime in January 2017, or 2017-01-01 for January 1, 2017. The abatement of a health concern may not always align with that of the underlying condition or problem. For example, a health concern may be abated when a person begins hospice care because it is no longer of concern to the person or their care team even though the condition may not be resolved.	-
statusReason	string	false	A textual representation of the reason the health concern is in its current status.	-
expressedBy	object	false	The individual responsible for initially establishing or expressing the health concern. This may not be the same person who actually captures the health concern representation in the system. An individual may express a health concern to another party who actually creates the concern.	-
» type	string	true	Describes the role the individual plays in relation to the health concern. Currently, the individual expressing the health concern can be the focus of the concern (SUBJECT), a medical professional in the tenant organization (PERSONNEL), or a person related to the focus of the health concern (RELATED_PERSON).	PERSONNEL, SUBJECT, RELATED_PERSON
» display	string	false	A textual display that identifies the individual being defined. If display is provided, the type must be RELATED_PERSON or PERSONNEL and reference cannot be provided.	-
» reference	object	false	A reference to the individual who expressed the health concern. If reference is provided, the type must be PERSONNEL and the display cannot be provided.	-
»» id	string	true	The unique ID of the referenced entity.	-
status	string	true	The current status of the health concern. The following statuses are possible: - ACTIVE: Indicates that signs or symptoms of the health concern are currently evident. - IN_ERROR: Indicates that the health concern was mistakenly identified. - 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. - PROPOSED: Indicates that the health concern was proposed. - ACCEPTED: Indicates that the health concern was accepted or acknowledged. - REJECTED: Indicates that the health concern was rejected.	IN_ERROR, ACTIVE, RELAPSE, REMISSION, RESOLVED, INACTIVE, PROPOSED, ACCEPTED, REJECTED
code	object	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. At minimum, the textual description of the health concern must be provided. While providing one or more standard codings is encouraged, it is not explicitly required. Once the health concern is created, codings associated with the health concern cannot be altered in any way.	-
» text	string	true	A human-readable, potentially personalized description of the health concern. This field must be provided for every health concern.	-
» 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.	-
»» display	string	false	The display value of a code in a coding system.	-
updatedBy	object	true	The individual who last modified the health concern in the system. When the health concern is first created, the value in ‘updatedBy’ is set by the service to match the ‘createdBy’ field.	-
» type	string	false	Describes 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	object	false	A reference to the individual. If reference is provided, the type must be PERSONNEL.	-
»» id	string	true	The unique 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.	-

postConsumersConsumeridHealthConcernsBatch

Name	Type	Required	Description	Accepted Values
healthConcerns	[object]	true	A list of health concerns to create. A maximum of 20 health concerns can be created for a patient.	-
» healthConcernDefinitionId	string	true	The unique ID of the health concern definition.	-
» status	string	true	The current status of the health concern. The following statuses are possible for health concerns: - ACTIVE: Indicates that signs or symptoms of the health concern are currently evident. - IN_ERROR: Indicates that the health concern was mistakenly identified. - 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 patient is no longer experiencing symptoms of the health concern or that evidence of the health concern no longer exists. - PROPOSED: Indicates that the health concern was proposed by the provider. - ACCEPTED: Indicates that the health concern was accepted or acknowledged by the patient. - REJECTED: Indicates that the health concern was rejected by the patient.	IN_ERROR, ACTIVE, RELAPSE, REMISSION, RESOLVED, INACTIVE, PROPOSED, ACCEPTED, REJECTED
createdBy	object	true	The individual responsible for creating the health concern within the system.	-
» type	string	false	Describes 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	object	false	A reference to the individual responsible for creating the health concern. If a reference is provided, the reference type must be PERSONNEL.	-
»» id	string	true	The unique ID of the referenced entity.	-
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.	-
» 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.	-

HealthConcernEntities

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

postConsumersConsumeridHealthConcerns

Name	Type	Required	Description	Accepted Values
onset	string	false	The estimated or actual date when the health concern began. In ISO formatting with precision ranging from YYYY to YYYY-MM-DD. This range of precision is allowed to support approximate onset dates, for example, 2017 for sometime in 2017, 2017-01 for sometime in January 2017, or 2017-01-01 for January 1, 2017. The onset of the health concern may not always align with that of the underlying problem or condition. For example, a person may be diagnosed with a condition for a period of time but that condition may not be raised to the level of a concern that needs to be actively managed until a later date.	-
abatement	string	false	The estimated or actual date when the health concern was resolved or went into remission. In ISO 8601 formatting with precision ranging from YYYY to YYYY-MM-DD. This range of precision is allowed to support approximate abatement time ranges, for example, 2017 for sometime in 2017, 2017-01 for sometime in January 2017, or 2017-01-01 for January 1, 2017. The abatement of a health concern may not always align with that of the underlying condition or problem. For example, a health concern may be abated when a person begins hospice care because it is no longer of concern to the person or their care team even though the condition may not be resolved.	-
statusReason	string	false	A textual representation of the reason the health concern is in its current status.	-
expressedBy	object	false	The individual responsible for initially establishing or expressing the health concern. This may not be the same person who actually captures the health concern representation in the system. An individual may express a health concern to another party who actually creates the concern.	-
» type	string	true	Describes the role the individual plays in relation to the health concern. Currently, the individual expressing the health concern can be the focus of the concern (SUBJECT), a medical professional in the tenant organization (PERSONNEL), or a person related to the focus of the health concern (RELATED_PERSON).	PERSONNEL, SUBJECT, RELATED_PERSON
» display	string	false	A textual display that identifies the individual being defined. If display is provided, the type must be RELATED_PERSON or PERSONNEL and reference cannot be provided.	-
» reference	object	false	A reference to the individual who expressed the health concern. If reference is provided, the type must be PERSONNEL and the display cannot be provided.	-
»» id	string	true	The unique ID of the referenced entity.	-
status	string	true	The current status of the health concern. The following statuses are possible: - ACTIVE: Indicates that signs or symptoms of the health concern are currently evident. - IN_ERROR: Indicates that the health concern was mistakenly identified. - 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. - PROPOSED: Indicates that the health concern was proposed. - ACCEPTED: Indicates that the health concern was accepted or acknowledged. - REJECTED: Indicates that the health concern was rejected.	IN_ERROR, ACTIVE, RELAPSE, REMISSION, RESOLVED, INACTIVE, PROPOSED, ACCEPTED, REJECTED
code	object	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. At minimum, the textual description of the health concern must be provided. While providing one or more standard codings is encouraged, it is not explicitly required. Once the health concern is created, codings associated with the health concern cannot be altered in any way.	-
» text	string	true	A human-readable, potentially personalized description of the health concern. This field must be provided for every health concern.	-
» 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.	-
»» display	string	false	The display value of a code in a coding system.	-
createdBy	object	true	The individual who created the health concern in the system.	-
» type	string	false	Describes 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	object	false	A reference to the individual. If reference is provided, the type must be PERSONNEL.	-
»» id	string	true	The unique ID of the referenced entity.	-
healthConcernDefinition	object	false	A reference to a health concern definition.	-
» id	string	true	The unique ID of the health concern definition.	-
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.	-

postHealthConcernDefinitions

Name	Type	Required	Description	Accepted Values
text	string	true	A textual description of the health concern definition.	-
status	string	true	The current status of the health concern definition.	ACTIVE, INACTIVE
concept	object	false	The most applicable concept to use for coding purposes when instantiating the defined health concern. Or, for searching purposes, the set of codes that are most applicable.	-

HealthConcernDefinitions

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

putHealthConcernDefinitions

Name	Type	Required	Description	Accepted Values
text	string	true	A textual description of the health concern definition.	-
status	string	true	The current status of the health concern definition.	ACTIVE, INACTIVE
concept	object	false	The most applicable concept to use for coding purposes when instantiating the defined health concern. Or, for searching purposes, the set of codes that are most applicable.	-

HealthConcernDefinitionContexts

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