NAV Navbar
Logo cerner
Ruby Shell

Wellness Application API v1

The HealtheIntent Wellness Application API enables systems to interact with the Wellness Application service.

URL: https://cernerdemo.api.us.healtheintent.com/wellness-application/v1

Risk Advisors

Campaign members can be assigned risk levels based on their responses to the Personal Health Assessment (PHA) or their screening results. Members who have a certain risk level can be assigned activities that are designed to help them reduce their risk level for the area. A wellness advisor allows suggested goals and activities to be grouped together and mapped to a specific domain and population.

Retrieve a List of Risk Advisors

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/risk-advisors', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "items": [
    {
      "id": "da799f06-5f53-41cb-9335-4cd291b91578",
      "description": "Blood pressure risk advisor: Shows goals and activities to help you manage your high blood pressure condition, as determined by your screening results",
      "domain": "demo.cernerdemo.wellness.healtheintent.com",
      "populationId": "02ba8e56-c2ed-41f2-a440-ab4c24df65f4",
      "dataPartitionId": "948929fd-7c5c-44ed-b028-f2b3549b9453",
      "suggestionSetId": "17c48b9b-934f-4d06-a750-f600d1f730db",
      "type": "PHA"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/risk-advisors?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/risk-advisors?offset=0&limit=20"
}

GET /risk-advisors

Retrieves a List of Risk Advisors, ordered alphabetically by type.

Parameters

Parameter In Type Required Default Description Accepted Values
type query string false N/A Filters the retrieved risk advisors by type. PHA, SCREENING
domain query string false N/A Filters the retrieved risk advisors by domain. -
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 Success RiskAdvisors
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Create a Risk Advisor

Example Request:




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

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

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/risk-advisors', headers: headers, body: {"description":"Blood pressure risk advisor: Shows goals and activities to help you manage your high blood pressure condition, as determined by your screening results","domain":"demo.cernerdemo.wellness.healtheintent.com","populationId":"8ec47476-e25e-454e-b517-e36c00548be3","dataPartitionId":"df7ba1b4-57e2-4636-a220-ebdb9b1bb627","suggestionSetId":"ce50f0a0-7a23-49b4-ba6e-664f7a3c43bf","type":"PHA"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/risk-advisors \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"description":"Blood pressure risk advisor: Shows goals and activities to help you manage your high blood pressure condition, as determined by your screening results","domain":"demo.cernerdemo.wellness.healtheintent.com","populationId":"8ec47476-e25e-454e-b517-e36c00548be3","dataPartitionId":"df7ba1b4-57e2-4636-a220-ebdb9b1bb627","suggestionSetId":"ce50f0a0-7a23-49b4-ba6e-664f7a3c43bf","type":"PHA"}

Example response

{
  "id": "da799f06-5f53-41cb-9335-4cd291b91578",
  "description": "Blood pressure risk advisor: Shows goals and activities to help you manage your high blood pressure condition, as determined by your screening results",
  "domain": "demo.cernerdemo.wellness.healtheintent.com",
  "populationId": "02ba8e56-c2ed-41f2-a440-ab4c24df65f4",
  "dataPartitionId": "948929fd-7c5c-44ed-b028-f2b3549b9453",
  "suggestionSetId": "17c48b9b-934f-4d06-a750-f600d1f730db",
  "type": "PHA"
}

POST /risk-advisors

Creates a risk advisor for the HealtheIntent tenant.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created Created RiskAdvisor
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError
409 Conflict Conflict ConflictError

Delete a Risk Advisor

Example Request:


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

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

result = HTTParty.delete('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/risk-advisors/11e8902c9e2908c69718f13503066bee', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/risk-advisors/11e8902c9e2908c69718f13503066bee \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /risk-advisors/{riskAdvisorId}

Deletes a single risk advisor by ID.

Parameters

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

Response Statuses

Status Meaning Description Schema
204 No Content No Content None
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
404 Not Found Not Found NotFoundError

Update a Risk Advisor

Example Request:




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

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

result = HTTParty.patch('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/risk-advisors/11e8902c9e2908c69718f13503066bee', headers: headers, body: {"description":"Blood pressure risk advisor: Shows goals and activities to help you manage your high blood pressure condition, as determined by your screening results","domain":"demo.cernerdemo.wellness.healtheintent.com","populationId":"8ec47476-e25e-454e-b517-e36c00548be3","dataPartitionId":"df7ba1b4-57e2-4636-a220-ebdb9b1bb627","suggestionSetId":"ce50f0a0-7a23-49b4-ba6e-664f7a3c43bf","type":"PHA"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PATCH https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/risk-advisors/11e8902c9e2908c69718f13503066bee \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"description":"Blood pressure risk advisor: Shows goals and activities to help you manage your high blood pressure condition, as determined by your screening results","domain":"demo.cernerdemo.wellness.healtheintent.com","populationId":"8ec47476-e25e-454e-b517-e36c00548be3","dataPartitionId":"df7ba1b4-57e2-4636-a220-ebdb9b1bb627","suggestionSetId":"ce50f0a0-7a23-49b4-ba6e-664f7a3c43bf","type":"PHA"}

PATCH /risk-advisors/{riskAdvisorId}

Updates risk advisor for a HealtheIntent tenant.

Parameters

Parameter In Type Required Default Description Accepted Values
riskAdvisorId path string true N/A The ID of the risk advisor. -
body body patchRiskAdvisors true N/A No description -

Response Statuses

Status Meaning Description Schema
204 No Content No Content None
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError
409 Conflict Conflict ConflictError

Retrieve a Single Risk Advisor

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/risk-advisors/11e8902c9e2908c69718f13503066bee', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "id": "da799f06-5f53-41cb-9335-4cd291b91578",
  "description": "Blood pressure risk advisor: Shows goals and activities to help you manage your high blood pressure condition, as determined by your screening results",
  "domain": "demo.cernerdemo.wellness.healtheintent.com",
  "populationId": "02ba8e56-c2ed-41f2-a440-ab4c24df65f4",
  "dataPartitionId": "948929fd-7c5c-44ed-b028-f2b3549b9453",
  "suggestionSetId": "17c48b9b-934f-4d06-a750-f600d1f730db",
  "type": "PHA"
}

GET /risk-advisors/{riskAdvisorId}

Retrieves a single risk advisor by ID.

Parameters

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

Response Statuses

Status Meaning Description Schema
200 OK Success RiskAdvisor
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Suggestion Sets

A suggestion set is a group of suggested goals and activities that can help manage a particular risk.

Create a Suggestion Set

Example Request:




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

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

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/suggestion-sets', headers: headers, body: {"description":"Suggestions for managing a high blood pressure condition.","status":"DRAFT"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/suggestion-sets \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"description":"Suggestions for managing a high blood pressure condition.","status":"DRAFT"}

Example response

{
  "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
  "description": "Suggestions for managing a high blood pressure condition",
  "status": "DRAFT"
}

POST /suggestion-sets

Creates a suggestion set using the specified parameters.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created Created SuggestionSet
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError

Retrieve a List of Suggestion Sets

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/suggestion-sets', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "items": [
    {
      "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
      "description": "Suggestions for managing a high blood pressure condition",
      "status": "DRAFT"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/suggestion-sets?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/suggestion-sets?offset=0&limit=20"
}

GET /suggestion-sets

Retrieves a list of suggestion sets.

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 Success SuggestionSets
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError

Update a Suggestion Set

Example Request:




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

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

result = HTTParty.patch('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/suggestion-sets/11e8902c9e2908c69718f13503066bee', headers: headers, body: {"description":"Suggestions for managing a high blood pressure condition.","status":"DRAFT"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PATCH https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/suggestion-sets/11e8902c9e2908c69718f13503066bee \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"description":"Suggestions for managing a high blood pressure condition.","status":"DRAFT"}

PATCH /suggestion-sets/{suggestionSetId}

Updates the description and status of a suggestion set. The status can be updated only from DRAFT to PUBLISHED to RETIRED.

Parameters

Parameter In Type Required Default Description Accepted Values
suggestionSetId path string true N/A The ID of the suggestion set. -
body body patchSuggestionSets true N/A No description -

Response Statuses

Status Meaning Description Schema
200 OK Success SuggestionSet
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
404 Not Found Not Found NotFoundError

Retrieve a Single Suggestion Set

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/suggestion-sets/11e8902c9e2908c69718f13503066bee', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
  "description": "Suggestions for managing a high blood pressure condition",
  "status": "DRAFT"
}

GET /suggestion-sets/{suggestionSetId}

Retrieves a single suggestion set by ID.

Parameters

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

Response Statuses

Status Meaning Description Schema
200 OK Success SuggestionSet
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
404 Not Found Not Found NotFoundError

Suggestions

A suggestion defines the criteria of a risk and the associated plan template that is suggested when the criteria are met. See the Plan Templates resource of the HealtheIntent Longitudinal Plan API for more information about plan templates.

Retrieve a List of Suggestions

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/suggestion-sets/11e8902c9e2908c69718f13503066bee/suggestions', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "items": [
    {
      "id": "df0cb612-95e6-4a8e-b8b7-a1fe9310eec9",
      "description": "Suggestion for maintaining Blood Pressure.",
      "risk": {
        "type": {
          "code": "35c3a7c39225c391387341c2aac323lds",
          "display": "Nutritional",
          "system": "SNOMED CT"
        },
        "method": {
          "code": "35c3a7c39225c391387341c2aac323lds",
          "display": "Nutritional",
          "system": "SNOMED CT"
        },
        "interpretation": "LOW_RISK_HIGH_BENEFIT"
      },
      "longPlanTemplate": {
        "id": "414c17a9-97c4-4d24-b612-b3a86bc66fca"
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/example/v1/examples?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/example/v1/examples?offset=0&limit=20"
}

GET /suggestion-sets/{suggestionSetId}/suggestions

Retrieves a list of suggestions that is ordered alphabetically by type.

Parameters

Parameter In Type Required Default Description Accepted Values
suggestionSetId path string true N/A The ID of the suggestion set. -
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 Success Suggestions
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Create a Suggestion

Example Request:




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

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

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/suggestion-sets/11e8902c9e2908c69718f13503066bee/suggestions', headers: headers, body: {"description":"Suggestion for managing a high blood pressure condition.","risk":{"type":{"code":"35c3a7c39225c391387341c2aac323lds","display":"Nutritional","system":"SNOMED CT"},"method":{"code":"35c3a7c39225c391387341c2aac323lds","display":"Nutritional","system":"SNOMED CT"},"interpretation":"LOW_RISK_HIGH_BENEFIT"},"longPlanTemplate":{"id":"77a233a3-54d4-4ad3-9e63-53bb71762290"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/suggestion-sets/11e8902c9e2908c69718f13503066bee/suggestions \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"description":"Suggestion for managing a high blood pressure condition.","risk":{"type":{"code":"35c3a7c39225c391387341c2aac323lds","display":"Nutritional","system":"SNOMED CT"},"method":{"code":"35c3a7c39225c391387341c2aac323lds","display":"Nutritional","system":"SNOMED CT"},"interpretation":"LOW_RISK_HIGH_BENEFIT"},"longPlanTemplate":{"id":"77a233a3-54d4-4ad3-9e63-53bb71762290"}}

Example response

{
  "id": "df0cb612-95e6-4a8e-b8b7-a1fe9310eec9",
  "description": "Suggestion for maintaining Blood Pressure.",
  "risk": {
    "type": {
      "code": "35c3a7c39225c391387341c2aac323lds",
      "display": "Nutritional",
      "system": "SNOMED CT"
    },
    "method": {
      "code": "35c3a7c39225c391387341c2aac323lds",
      "display": "Nutritional",
      "system": "SNOMED CT"
    },
    "interpretation": "LOW_RISK_HIGH_BENEFIT"
  },
  "longPlanTemplate": {
    "id": "414c17a9-97c4-4d24-b612-b3a86bc66fca"
  }
}

POST /suggestion-sets/{suggestionSetId}/suggestions

Creates a suggestion using the specified parameters.

Parameters

Parameter In Type Required Default Description Accepted Values
suggestionSetId path string true N/A The ID of the suggestion set. -
body body postSuggestionSetsSuggestionsetidSuggestions true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created Created Suggestion
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Delete a Suggestion

Example Request:


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

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

result = HTTParty.delete('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/suggestion-sets/11e8902c9e2908c69718f13503066bee/suggestions/11e8902c9e2908c69718f13503066bee', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/suggestion-sets/11e8902c9e2908c69718f13503066bee/suggestions/11e8902c9e2908c69718f13503066bee \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /suggestion-sets/{suggestionSetId}/suggestions/{suggestionId}

Deletes a single suggestion by ID. This can be done only if the status of the suggestion set is DRAFT.

Parameters

Parameter In Type Required Default Description Accepted Values
suggestionSetId path string true N/A The ID of the suggestion set. -
suggestionId path string true N/A The ID of the suggestion. -

Response Statuses

Status Meaning Description Schema
204 No Content No Content None
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Update a Suggestion

Example Request:




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

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

result = HTTParty.put('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/suggestion-sets/11e8902c9e2908c69718f13503066bee/suggestions/11e8902c9e2908c69718f13503066bee', headers: headers, body: {"description":"Suggestion for managing a high blood pressure condition.","risk":{"type":{"code":"35c3a7c39225c391387341c2aac323lds","display":"Nutritional","system":"SNOMED CT"},"method":{"code":"35c3a7c39225c391387341c2aac323lds","display":"Nutritional","system":"SNOMED CT"},"interpretation":"LOW_RISK_HIGH_BENEFIT"},"longPlanTemplate":{"id":"77a233a3-54d4-4ad3-9e63-53bb71762290"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/suggestion-sets/11e8902c9e2908c69718f13503066bee/suggestions/11e8902c9e2908c69718f13503066bee \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"description":"Suggestion for managing a high blood pressure condition.","risk":{"type":{"code":"35c3a7c39225c391387341c2aac323lds","display":"Nutritional","system":"SNOMED CT"},"method":{"code":"35c3a7c39225c391387341c2aac323lds","display":"Nutritional","system":"SNOMED CT"},"interpretation":"LOW_RISK_HIGH_BENEFIT"},"longPlanTemplate":{"id":"77a233a3-54d4-4ad3-9e63-53bb71762290"}}

PUT /suggestion-sets/{suggestionSetId}/suggestions/{suggestionId}

Updates a single suggestion. This can be done only if the status of the suggestion set is DRAFT.

Parameters

Parameter In Type Required Default Description Accepted Values
suggestionSetId path string true N/A The ID of the suggestion set. -
suggestionId path string true N/A The ID of the suggestion. -
body body putSuggestionSetsSuggestionsetidSuggestions true N/A No description -

Response Statuses

Status Meaning Description Schema
200 OK Success Suggestion
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Retrieve a Single Suggestion

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/suggestion-sets/11e8902c9e2908c69718f13503066bee/suggestions/11e8902c9e2908c69718f13503066bee', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "id": "df0cb612-95e6-4a8e-b8b7-a1fe9310eec9",
  "description": "Suggestion for maintaining Blood Pressure.",
  "risk": {
    "type": {
      "code": "35c3a7c39225c391387341c2aac323lds",
      "display": "Nutritional",
      "system": "SNOMED CT"
    },
    "method": {
      "code": "35c3a7c39225c391387341c2aac323lds",
      "display": "Nutritional",
      "system": "SNOMED CT"
    },
    "interpretation": "LOW_RISK_HIGH_BENEFIT"
  },
  "longPlanTemplate": {
    "id": "414c17a9-97c4-4d24-b612-b3a86bc66fca"
  }
}

GET /suggestion-sets/{suggestionSetId}/suggestions/{suggestionId}

Retrieves a single suggestion by ID.

Parameters

Parameter In Type Required Default Description Accepted Values
suggestionSetId path string true N/A The ID of the suggestion set. -
suggestionId path string true N/A The ID of the suggestion. -

Response Statuses

Status Meaning Description Schema
200 OK Success Suggestion
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Published Suggestions

Published suggestions are the suggested goals and activities for a particular risk level for a risk advisor. When a suggestion set is linked to an advisor, a PublishedSuggestion object that includes all of the suggestions for the risk advisor is generated and stored internally.

Retrieve a List of Published Suggestions

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/published-suggestions', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "items": [
    {
      "type": "PHA",
      "domain": "demo.cernerdemo.wellness.healtheintent.com",
      "description": "Blood pressure risk advisor: Shows goals and activities to help you manage your high blood pressure condition, as determined by your screening results",
      "populationId": "c08b0afe-8d46-11e9-bc42-526af7764f64",
      "dataPartitionId": "1a2d1b02-3175-4f21-8dff-67c43e201a4c",
      "suggestions": [
        {
          "id": "442e645f-7162-401b-8f2f-7ca92d27d6a3",
          "longPlanTemplate": {
            "id": "35c3a7c39225c391387341c2aac323lds"
          },
          "risk": {
            "type": {
              "code": "35c3a7c39225c391387341c2aac323lds",
              "display": "Nutritional",
              "system": "SNOMED CT"
            },
            "method": {
              "code": "35c3a7c39225c391387341c2aac323lds",
              "display": "Nutritional",
              "system": "SNOMED CT"
            },
            "interpretation": "LOW_RISK_HIGH_BENEFIT"
          },
          "goalDefinitions": [
            {
              "id": "11e8902c9e2908c69718f13503066bee",
              "text": "Complete your PHA",
              "coding": {
                "code": "35c3a7c39225c391387341c2aac323lds",
                "display": "Nutritional",
                "system": "SNOMED CT"
              },
              "activityDefinitions": [
                {
                  "id": "11e8902c9e2908c69718f13503066bee",
                  "text": "Log steps",
                  "description": "Activity for logging steps",
                  "coding": {
                    "code": "35c3a7c39225c391387341c2aac323lds",
                    "display": "Nutritional",
                    "system": "SNOMED CT"
                  }
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/example/v1/examples?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/example/v1/examples?offset=0&limit=20"
}

GET /published-suggestions

Retrieves a list of published suggestions that can be used in applications. The list is ordered alphabetically by type.

Parameters

Parameter In Type Required Default Description Accepted Values
type query string false N/A Filters the retrieved published suggestions by type. PHA, SCREENING
domain query string false N/A Filters the retrieved published suggestions by domain. -
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 Success PublishedSuggestions
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Event Configuration

Event configurations enable building, presenting, and grouping wellness events in the Wellness Application service. Wellness events are activities that are intended to support the discovery and development of healthy habits.

Retrieve a List of Event Configurations

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/event-configs', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "items": [
    {
      "id": "6d743472-79ba-4f94-ba57-233ba8444a86",
      "domain": "demo.cernerdemo.wellness.us.healtheintent.com",
      "catalogs": [
        {
          "id": "f04034b5-80dc-4175-bcaf-66376576ee84"
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/event-configs?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/event-configs?offset=0&limit=20"
}

GET /event-configs

Retrieves all of the available event configurations for a HealtheIntent tenant.

Parameters

Parameter In Type Required Default Description Accepted Values
domain query string false N/A Filters the retrieved events by the domain of the event configuration. -
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 Success. EventConfigs
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Create an Event Configuration

Example Request:




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

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

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/event-configs', headers: headers, body: {"domain":"demo.cernerdemo.wellness.us.healtheintent.com","catalogs":[{"id":"f04034b5-80dc-4175-bcaf-66376576ee84"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/event-configs \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"domain":"demo.cernerdemo.wellness.us.healtheintent.com","catalogs":[{"id":"f04034b5-80dc-4175-bcaf-66376576ee84"}]}

POST /event-configs

Creates an event configuration for a HealtheIntent tenant.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created Created EventConfig
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Delete an Event Configuration

Example Request:


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

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

result = HTTParty.delete('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/event-configs/a7023b63-7be6-4be3-9570-c2b6099c9356', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/event-configs/a7023b63-7be6-4be3-9570-c2b6099c9356 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /event-configs/{eventConfigId}

Deletes a single event configuration for a HealtheIntent tenant.

Parameters

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

Response Statuses

Status Meaning Description Schema
204 No Content Deleted None
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Update an Event Configuration

Example Request:




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

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

result = HTTParty.put('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/event-configs/a7023b63-7be6-4be3-9570-c2b6099c9356', headers: headers, body: {"domain":"demo.cernerdemo.wellness.us.healtheintent.com","catalogs":[{"id":"f04034b5-80dc-4175-bcaf-66376576ee84"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/event-configs/a7023b63-7be6-4be3-9570-c2b6099c9356 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"domain":"demo.cernerdemo.wellness.us.healtheintent.com","catalogs":[{"id":"f04034b5-80dc-4175-bcaf-66376576ee84"}]}

PUT /event-configs/{eventConfigId}

Updates a single event configuration for a HealtheIntent tenant.

Parameters

Parameter In Type Required Default Description Accepted Values
eventConfigId path string true N/A The ID of the event configuration. -
body body putEventConfigs true N/A No description -

Response Statuses

Status Meaning Description Schema
204 No Content Updated None
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Retrieve a Single Event Configuration

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/event-configs/a7023b63-7be6-4be3-9570-c2b6099c9356', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/event-configs/a7023b63-7be6-4be3-9570-c2b6099c9356 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

GET /event-configs/{eventConfigId}

Retrieves a single event configuration for a HealtheIntent tenant.

Parameters

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

Response Statuses

Status Meaning Description Schema
200 OK Success EventConfig
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Learning Module Configuration

Learning modules are collections of topics with a specific focus and are designed to enhance the well-being of users with educational resources.

Retrieve a List of Learning Module Configurations

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/learning-module-configs', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/learning-module-configs \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "6d743472-79ba-4f94-ba57-233ba8444a86",
      "domain": "demo.cernerdemo.wellness.us.healtheintent.com",
      "catalogs": [
        {
          "id": "f04034b5-80dc-4175-bcaf-66376576ee84"
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/learning-module-configs?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/learning-module-configs?offset=0&limit=20"
}

GET /learning-module-configs

Retrieves all of the available learning module configurations for a HealtheIntent tenant.

Parameters

Parameter In Type Required Default Description Accepted Values
domain query string false N/A Filters the retrieved learning modules by the domain of the wellness application. -
catalogId query string false N/A Filters the retrieved learning modules by the catalog 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 Success. LearningModuleConfigs
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Create a Learning Module Configuration

Example Request:




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

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

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/learning-module-configs', headers: headers, body: {"domain":"demo.cernerdemo.wellness.us.healtheintent.com","catalogs":[{"id":"f04034b5-80dc-4175-bcaf-66376576ee84"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/learning-module-configs \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"domain":"demo.cernerdemo.wellness.us.healtheintent.com","catalogs":[{"id":"f04034b5-80dc-4175-bcaf-66376576ee84"}]}

POST /learning-module-configs

Creates a learning module configuration for a HealtheIntent tenant.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created Created LearningModuleConfig
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Delete a Learning Module Configuration

Example Request:


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

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

result = HTTParty.delete('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/learning-module-configs/f04034b5-80dc-4175-bcaf-66376576ee84', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/learning-module-configs/f04034b5-80dc-4175-bcaf-66376576ee84 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /learning-module-configs/{learningModuleConfigId}

Deletes a single learning module configuration for a HealtheIntent tenant.

Parameters

Parameter In Type Required Default Description Accepted Values
learningModuleConfigId path string true N/A The ID of the learning module configuration. -

Response Statuses

Status Meaning Description Schema
204 No Content Deleted None
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Update a Learning Module Configuration

Example Request:




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

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

result = HTTParty.put('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/learning-module-configs/f04034b5-80dc-4175-bcaf-66376576ee84', headers: headers, body: {"domain":"demo.cernerdemo.wellness.us.healtheintent.com","catalogs":[{"id":"f04034b5-80dc-4175-bcaf-66376576ee84"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/learning-module-configs/f04034b5-80dc-4175-bcaf-66376576ee84 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"domain":"demo.cernerdemo.wellness.us.healtheintent.com","catalogs":[{"id":"f04034b5-80dc-4175-bcaf-66376576ee84"}]}

PUT /learning-module-configs/{learningModuleConfigId}

Updates a single learning module configuration for a HealtheIntent tenant.

Parameters

Parameter In Type Required Default Description Accepted Values
learningModuleConfigId path string true N/A The ID of the learning module configuration. -
body body putLearningModuleConfigs true N/A No description -

Response Statuses

Status Meaning Description Schema
204 No Content Updated None
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Retrieve a Single Learning Module Configuration

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/learning-module-configs/f04034b5-80dc-4175-bcaf-66376576ee84', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/learning-module-configs/f04034b5-80dc-4175-bcaf-66376576ee84 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

GET /learning-module-configs/{learningModuleConfigId}

Retrieves a single learning module configuration for a HealtheIntent tenant.

Parameters

Parameter In Type Required Default Description Accepted Values
learningModuleConfigId path string true N/A The ID of the learning module configuration. -

Response Statuses

Status Meaning Description Schema
200 OK Success LearningModuleConfig
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

PHA Configuration

Personal health assessment (PHA) configurations enable building and presenting personal health assessments, health risks, and advisor focus areas in the Wellness Application service. A PHA is a structured set of questions and instructions that can be used to collect answers from users.

Retrieve a List of PHA Configurations

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/pha-configs', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "items": [
    {
      "id": "6d743472-79ba-4f94-ba57-233ba8444a86",
      "domain": "demo.cernerdemo.wellness.us.healtheintent.com",
      "phaDefinitions": {
        "id": "2cfa3c40-acf0-43bc-ac76-8a7ec2b1baea",
        "locale": "en-US"
      },
      "phaFocusAreas": {
        "id": "1f110749-4184-4199-9b8f-d7b7d39728ad"
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/pha-configs?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/pha-configs?offset=0&limit=20"
}

GET /pha-configs

Retrieves all of the available PHA configurations for a HealtheIntent tenant.

Parameters

Parameter In Type Required Default Description Accepted Values
domain query string false N/A Filters by the domain of the wellness application. -
phaDefinitionId query string false N/A Filters by the ID of the PHA 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 Success. PhaConfigs
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Create a PHA Configuration

Example Request:




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

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

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/pha-configs', headers: headers, body: {"domain":"demo.cernerdemo.wellness.us.healtheintent.com","phaDefinitions":[{"id":"2cfa3c40-acf0-43bc-ac76-8a7ec2b1baea","locale":"en-US"}],"phaFocusAreas":[{"id":"1f110749-4184-4199-9b8f-d7b7d39728ad"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/pha-configs \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"domain":"demo.cernerdemo.wellness.us.healtheintent.com","phaDefinitions":[{"id":"2cfa3c40-acf0-43bc-ac76-8a7ec2b1baea","locale":"en-US"}],"phaFocusAreas":[{"id":"1f110749-4184-4199-9b8f-d7b7d39728ad"}]}

POST /pha-configs

Creates a new PHA configuration for a HealtheIntent tenant.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created Created PhaConfig
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Update a PHA Configuration

Example Request:




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

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

result = HTTParty.put('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/pha-configs/dfbc49d2-725d-457e-9012-f2e0e80a886e', headers: headers, body: {"domain":"demo.cernerdemo.wellness.us.healtheintent.com","phaDefinitions":[{"id":"2cfa3c40-acf0-43bc-ac76-8a7ec2b1baea","locale":"en-US"}],"phaFocusAreas":[{"id":"1f110749-4184-4199-9b8f-d7b7d39728ad"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/pha-configs/dfbc49d2-725d-457e-9012-f2e0e80a886e \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"domain":"demo.cernerdemo.wellness.us.healtheintent.com","phaDefinitions":[{"id":"2cfa3c40-acf0-43bc-ac76-8a7ec2b1baea","locale":"en-US"}],"phaFocusAreas":[{"id":"1f110749-4184-4199-9b8f-d7b7d39728ad"}]}

PUT /pha-configs/{phaConfigId}

Updates a single PHA configuration for a HealtheIntent tenant.

Parameters

Parameter In Type Required Default Description Accepted Values
phaConfigId path string true N/A The ID of the PHA configuration. -
body body putPhaConfigs true N/A No description -

Response Statuses

Status Meaning Description Schema
204 No Content Updated None
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Retrieve a Single PHA Configuration

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/pha-configs/dfbc49d2-725d-457e-9012-f2e0e80a886e', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/pha-configs/dfbc49d2-725d-457e-9012-f2e0e80a886e \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

GET /pha-configs/{phaConfigId}

Retrieves a single PHA configuration for a HealtheIntent tenant.

Parameters

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

Response Statuses

Status Meaning Description Schema
200 OK Success PhaConfig
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Retrieve a List of PHA Focus Areas

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/pha-focus-areas', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/pha-focus-areas \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "6d743472-79ba-4f94-ba57-233ba8444a86",
      "phaSection": {
        "id": "da4cac69-462d-4e3e-8870-a39fad628354",
        "phaDefinitionId": "945e3db8-5fc8-4adb-81f1-d91fd7c8fd48"
      },
      "riskType": {
        "id": "da4cac69-462d-4e3e-8870-a39fad628354"
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/pha-focus-areas?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/pha-focus-areas?offset=0&limit=20"
}

GET /pha-focus-areas

Retrieves all of the available PHA focus areas for a HealtheIntent tenant.

Parameters

Parameter In Type Required Default Description Accepted Values
domain query string false N/A Filters by the domain of the wellness application. -
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 Success. PhaFocusAreas
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Create a PHA Focus Area

Example Request:




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

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

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/pha-focus-areas', headers: headers, body: {"phaSection":{"id":"da4cac69-462d-4e3e-8870-a39fad628354","phaDefinitionId":"945e3db8-5fc8-4adb-81f1-d91fd7c8fd48"},"riskType":{"id":"da4cac69-462d-4e3e-8870-a39fad628354"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/pha-focus-areas \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"phaSection":{"id":"da4cac69-462d-4e3e-8870-a39fad628354","phaDefinitionId":"945e3db8-5fc8-4adb-81f1-d91fd7c8fd48"},"riskType":{"id":"da4cac69-462d-4e3e-8870-a39fad628354"}}

POST /pha-focus-areas

Creates a PHA focus area for a HealtheIntent tenant. A PHA focus area is a key area of an individual’s wellness that is used for assessing their health risk and delivering personalized recommendations.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created Created PhaFocusArea
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Retrieve a Single PHA Focus Area

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/pha-focus-areas/afaf3830-8a8c-4165-bca6-b713d4a31164', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/pha-focus-areas/afaf3830-8a8c-4165-bca6-b713d4a31164 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

GET /pha-focus-areas/{phaFocusAreaId}

Retrieves a single PHA focus area for a HealtheIntent tenant.

Parameters

Parameter In Type Required Default Description Accepted Values
phaFocusAreaId path string true N/A The ID of the PHA focus area. -

Response Statuses

Status Meaning Description Schema
200 OK Success PhaFocusArea
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Health Tracker Configuration

Health tracker configurations enable building and presenting health and fitness trackers and their metrics in the Wellness Application service. Health and fitness trackers are devices that are used to monitor activity, biometrics, sleep, and exercise to improve an individual’s overall health.

Create a Health Tracker Configuration

Example Request:




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

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

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/health-tracker-configs', headers: headers, body: {"domain":"demo.cernerdemo.wellness.us.healtheintent.com","trackingMetric":{"id":"1c2b8b6d-c978-4223-a223-632f830f27d3"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/health-tracker-configs \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"domain":"demo.cernerdemo.wellness.us.healtheintent.com","trackingMetric":{"id":"1c2b8b6d-c978-4223-a223-632f830f27d3"}}

POST /health-tracker-configs

Creates a new health tracker configuration for a HealtheIntent tenant.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created Created. HealthTrackerConfig
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Retrieve a List of Health Tracker Configurations

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/health-tracker-configs', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "items": [
    {
      "id": "b737408e-c784-435d-95a9-2f1f10b84e8e",
      "domain": "demo.cernerdemo.wellness.us.healtheintent.com",
      "trackingMetric": {
        "id": "4ab0db98-23ed-4ffe-83c4-f5d65ff6cda6",
        "steps": {
          "manualEntryEnabled": true,
          "longPlanActivityDefinition": {
            "id": "db4bd317-68f5-4a2c-ba9d-cc291e2f08f1"
          }
        },
        "physicalActivity": {
          "manualEntryEnabled": true,
          "longPlanActivityDefinition": {
            "id": "db4bd317-68f5-4a2c-ba9d-cc291e2f08f1"
          }
        },
        "bloodPressure": {
          "manualEntryEnabled": true
        },
        "bloodGlucose": {
          "manualEntryEnabled": true
        },
        "weight": {
          "manualEntryEnabled": true,
          "longPlanActivityDefinition": {
            "id": "db4bd317-68f5-4a2c-ba9d-cc291e2f08f1"
          }
        }
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/health-tracker-configs?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/health-tracker-configs?offset=0&limit=20"
}

GET /health-tracker-configs

Retrieves all of the available health tracker configurations for a HealtheIntent tenant.

Parameters

Parameter In Type Required Default Description Accepted Values
domain query string false N/A Filters by the domain name of the wellness application. -
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 Success. HealthTrackerConfigSummaries
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Update a Health Tracker Configuration

Example Request:




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

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

result = HTTParty.put('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/health-tracker-configs/cd5f024d-db77-4cb6-b44f-5bc8bd7878ba', headers: headers, body: {"domain":"demo.cernerdemo.wellness.us.healtheintent.com","trackingMetric":{"id":"1c2b8b6d-c978-4223-a223-632f830f27d3"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/health-tracker-configs/cd5f024d-db77-4cb6-b44f-5bc8bd7878ba \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"domain":"demo.cernerdemo.wellness.us.healtheintent.com","trackingMetric":{"id":"1c2b8b6d-c978-4223-a223-632f830f27d3"}}

PUT /health-tracker-configs/{healthTrackerConfigurationId}

Updates a health tracker configuration for a HealtheIntent tenant.

Parameters

Parameter In Type Required Default Description Accepted Values
healthTrackerConfigurationId path string true N/A The ID of the health tracker configuration. -
body body putHealthTrackerConfigs true N/A No description -

Response Statuses

Status Meaning Description Schema
204 No Content Updated. None
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Retrieve a Single Health Tracker Configuration

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/health-tracker-configs/cd5f024d-db77-4cb6-b44f-5bc8bd7878ba', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/health-tracker-configs/cd5f024d-db77-4cb6-b44f-5bc8bd7878ba \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

GET /health-tracker-configs/{healthTrackerConfigurationId}

Retrieves a single health tracker configuration for a HealtheIntent tenant.

Parameters

Parameter In Type Required Default Description Accepted Values
healthTrackerConfigurationId path string true N/A The ID of the health tracker configuration. -

Response Statuses

Status Meaning Description Schema
200 OK Success. HealthTrackerConfigSummary
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Create a Tracking Metric

Example Request:




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

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

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/tracking-metrics', headers: headers, body: {"steps":{"manualEntryEnabled":true,"longPlanActivityDefinition":{"id":"db4bd317-68f5-4a2c-ba9d-cc291e2f08f1"}},"physicalActivity":{"manualEntryEnabled":true,"longPlanActivityDefinition":{"id":"db4bd317-68f5-4a2c-ba9d-cc291e2f08f1"}},"bloodPressure":{"manualEntryEnabled":true},"bloodGlucose":{"manualEntryEnabled":true},"weight":{"manualEntryEnabled":true,"longPlanActivityDefinition":{"id":"db4bd317-68f5-4a2c-ba9d-cc291e2f08f1"}}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/tracking-metrics \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"steps":{"manualEntryEnabled":true,"longPlanActivityDefinition":{"id":"db4bd317-68f5-4a2c-ba9d-cc291e2f08f1"}},"physicalActivity":{"manualEntryEnabled":true,"longPlanActivityDefinition":{"id":"db4bd317-68f5-4a2c-ba9d-cc291e2f08f1"}},"bloodPressure":{"manualEntryEnabled":true},"bloodGlucose":{"manualEntryEnabled":true},"weight":{"manualEntryEnabled":true,"longPlanActivityDefinition":{"id":"db4bd317-68f5-4a2c-ba9d-cc291e2f08f1"}}}

POST /tracking-metrics

Registers a new health and fitness tracking metric for a HealtheIntent tenant.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created Created. TrackingMetric
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Retrieve a List of Tracking Metrics

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/tracking-metrics', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "items": [
    {
      "id": "4ab0db98-23ed-4ffe-83c4-f5d65ff6cda6",
      "steps": {
        "manualEntryEnabled": true,
        "longPlanActivityDefinition": {
          "id": "db4bd317-68f5-4a2c-ba9d-cc291e2f08f1"
        }
      },
      "physicalActivity": {
        "manualEntryEnabled": true,
        "longPlanActivityDefinition": {
          "id": "db4bd317-68f5-4a2c-ba9d-cc291e2f08f1"
        }
      },
      "bloodPressure": {
        "manualEntryEnabled": true
      },
      "bloodGlucose": {
        "manualEntryEnabled": true
      },
      "weight": {
        "manualEntryEnabled": true,
        "longPlanActivityDefinition": {
          "id": "db4bd317-68f5-4a2c-ba9d-cc291e2f08f1"
        }
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/health-tracker-app/v1/tracking-metrics?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/health-tracker-app/v1/tracking-metrics?offset=0&limit=20"
}

GET /tracking-metrics

Retrieves all of the available health and fitness tracking metrics for a HealtheIntent tenant.

Parameters

Parameter In Type Required Default Description Accepted Values
domain query string false N/A Filters by the domain name of the wellness application. -
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 Success. TrackingMetrics
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Retrieve a Single Tracking Metric

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/tracking-metrics/7f48346e-3344-43e6-9e98-0443c3f9a5bf', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/tracking-metrics/7f48346e-3344-43e6-9e98-0443c3f9a5bf \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

GET /tracking-metrics/{trackingMetricId}

Retrieves a single health and fitness tracking metric for a HealtheIntent tenant.

Parameters

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

Response Statuses

Status Meaning Description Schema
200 OK Success. TrackingMetric
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Campaign Notifications

Campaign notifications are messages that are sent to the HealtheIntent consumers who are enrolled in a wellness campaign. Messages can be sent in the form of emails, push notifications, or short message service (SMS) messages. Notifications can be configured to be sent when a campaign starts, is underway, or ends soon.

Retrieve a List of Campaign Notifications

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/campaign-configs/11e8902c9e2908c69718f13503066bee/notifications', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "items": [
    {
      "id": "20556922-21e0-46dc-9224-7b914bb67b5d",
      "campaignId": "a4c5aebb-1afa-4d50-8cbf-41cbc2af419a",
      "domain": "demo.cernerdemo.wellness.healtheintent.com",
      "locale": "en-US",
      "notifiableEventName": "CAMPAIGN_ENDING_SOON",
      "emailContent": {
        "emailSubject": "Campaign ending soon!",
        "emailContentHtml": "<!DOCTYPE html>\\n<html lang=\\\"en\\\">\\n <head>\\n <meta charset=\\\"utf-8\\\" />\\n <p> Hi {{first_name}},</p>\\n <p> <html>The campaign is ending soon! Earn all your points</html>.</p>\\n",
        "emailContentPlaintext": "Hi {{first_name}},\\n The campaign is ending soon! Earn all your points.\\n"
      },
      "smsContent": "The campaign is ending soon! Earn all your points. View your profile to edit message settings.",
      "mobileContent": {
        "mobilePushSubject": "Campaign ending soon!",
        "mobilePushContent": "The campaign is ending soon! Earn all your points."
      },
      "modalityFeatureFlags": {
        "emailEnabled": false,
        "smsEnabled": false,
        "mobilePushEnabled": false
      },
      "defaultNotificationPreferences": {
        "desiresEmail": true,
        "desiresSms": true,
        "desiresMobilePush": true
      },
      "sendNotificationOn": "2019-09-15"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/example/v1/examples?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/example/v1/examples?offset=0&limit=20"
}

GET /campaign-configs/{campaignConfigId}/notifications

Retrieves a list of campaign notifications.

Parameters

Parameter In Type Required Default Description Accepted Values
campaignConfigId path string true N/A The ID of the campaign configuration for a specific domain. -
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. -
campaignId query string false N/A Filters the retrieved campaign notifications by campaign ID. -
notifiableEventName query string false N/A Filters the retrieved campaign notifications by notifiable event name. CAMPAIGN_BEGINNING, MID_CAMPAIGN, CAMPAIGN_ENDING_SOON

Response Statuses

Status Meaning Description Schema
200 OK Success CampaignNotifications
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Create a Campaign Notification

Example Request:




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

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

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/campaign-configs/872fe01d-6539-45c3-b656-a7905baad46e/notifications', headers: headers, body: {"locale":"en-US","campaignId":"a4c5aebb-1afa-4d50-8cbf-41cbc2af419a","notifiableEventName":"CAMPAIGN_ENDING_SOON","smsContent":"The campaign is ending soon! Earn all your points. View your profile to edit message settings.","emailContent":{"emailSubject":"Campaign ending soon!","emailContentHtml":"<!DOCTYPE html>\\n<html lang=\\\"en\\\">\\n <head>\\n <meta charset=\\\"utf-8\\\" />\\n <p> Hi {{first_name}},</p>\\n <p> <html>The campaign is ending soon! Earn all your points</html>.</p>\\n","emailContentPlaintext":"Hi {{first_name}},\\n The campaign is ending soon! Earn all your points.\\n"},"mobileContent":{"mobilePushSubject":"Campaign ending soon!","mobilePushContent":"The campaign is ending soon! Earn all your points."},"modalityFeatureFlags":{"emailEnabled":false,"smsEnabled":false,"mobilePushEnabled":false},"defaultNotificationPreferences":{"desiresEmail":true,"desiresSms":true,"desiresMobilePush":true},"sendNotificationOn":"2019-09-15"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/campaign-configs/872fe01d-6539-45c3-b656-a7905baad46e/notifications \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"locale":"en-US","campaignId":"a4c5aebb-1afa-4d50-8cbf-41cbc2af419a","notifiableEventName":"CAMPAIGN_ENDING_SOON","smsContent":"The campaign is ending soon! Earn all your points. View your profile to edit message settings.","emailContent":{"emailSubject":"Campaign ending soon!","emailContentHtml":"<!DOCTYPE html>\\n<html lang=\\\"en\\\">\\n <head>\\n <meta charset=\\\"utf-8\\\" />\\n <p> Hi {{first_name}},</p>\\n <p> <html>The campaign is ending soon! Earn all your points</html>.</p>\\n","emailContentPlaintext":"Hi {{first_name}},\\n The campaign is ending soon! Earn all your points.\\n"},"mobileContent":{"mobilePushSubject":"Campaign ending soon!","mobilePushContent":"The campaign is ending soon! Earn all your points."},"modalityFeatureFlags":{"emailEnabled":false,"smsEnabled":false,"mobilePushEnabled":false},"defaultNotificationPreferences":{"desiresEmail":true,"desiresSms":true,"desiresMobilePush":true},"sendNotificationOn":"2019-09-15"}

Example response

{
  "id": "20556922-21e0-46dc-9224-7b914bb67b5d",
  "campaignId": "a4c5aebb-1afa-4d50-8cbf-41cbc2af419a",
  "domain": "demo.cernerdemo.wellness.healtheintent.com",
  "locale": "en-US",
  "notifiableEventName": "CAMPAIGN_ENDING_SOON",
  "emailContent": {
    "emailSubject": "Campaign ending soon!",
    "emailContentHtml": "<!DOCTYPE html>\\n<html lang=\\\"en\\\">\\n <head>\\n <meta charset=\\\"utf-8\\\" />\\n <p> Hi {{first_name}},</p>\\n <p> <html>The campaign is ending soon! Earn all your points</html>.</p>\\n",
    "emailContentPlaintext": "Hi {{first_name}},\\n The campaign is ending soon! Earn all your points.\\n"
  },
  "smsContent": "The campaign is ending soon! Earn all your points. View your profile to edit message settings.",
  "mobileContent": {
    "mobilePushSubject": "Campaign ending soon!",
    "mobilePushContent": "The campaign is ending soon! Earn all your points."
  },
  "modalityFeatureFlags": {
    "emailEnabled": false,
    "smsEnabled": false,
    "mobilePushEnabled": false
  },
  "defaultNotificationPreferences": {
    "desiresEmail": true,
    "desiresSms": true,
    "desiresMobilePush": true
  },
  "sendNotificationOn": "2019-09-15"
}

POST /campaign-configs/{campaignConfigId}/notifications

Creates a campaign notification. Placeholders can be used to automatically personalize \ the content of the campaign notification. The placeholder values below are available. \ To add a placeholder, include it inside braces, for example, {{first_name}}.
- first_name \
- last_name \
- campaignName \
- campaignDescription \
- campaignStartDate \
- campaignEndDate \
- totalEarned \
- maxPoints

Parameters

Parameter In Type Required Default Description Accepted Values
campaignConfigId path string true N/A The ID of the campaign configuration for a specific domain. -
body body postCampaignConfigsCampaignconfigidNotifications true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created Created CampaignNotification
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Delete a Notification From a Campaign Configuration

Example Request:


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

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

result = HTTParty.delete('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/campaign-configs/872fe01d-6539-45c3-b656-a7905baad46e/notifications/11e8902c9e2908c69718f13503066bee', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/campaign-configs/872fe01d-6539-45c3-b656-a7905baad46e/notifications/11e8902c9e2908c69718f13503066bee \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /campaign-configs/{campaignConfigId}/notifications/{notificationId}

Deletes a single notification based on its ID.

Parameters

Parameter In Type Required Default Description Accepted Values
notificationId path string true N/A The ID of the campaign notification. -
campaignConfigId path string true N/A The ID of the campaign configuration for a specific domain. -

Response Statuses

Status Meaning Description Schema
204 No Content No Content None
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Campaign Configuration

Campaign configurations enable building, presenting, and grouping campaign notifications in the Wellness Application service.

Retrieve a List of Campaign Configurations

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/campaign-configs', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "id": "20556922-21e0-46dc-9224-7b914bb67b5d",
  "domain": "demo.cernerdemo.wellness.healtheintent.com"
}

GET /campaign-configs

Retrieves a list of campaign configurations for a tenant.

Parameters

Parameter In Type Required Default Description Accepted Values
domain query string false N/A Filters by the domain of the campaign configuration. -
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 Success CampaignConfig
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Create a Campaign Configuration

Example Request:




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

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

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/campaign-configs', headers: headers, body: {"domain":"demo.cernerdemo.wellness.healtheintent.com"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/campaign-configs \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"domain":"demo.cernerdemo.wellness.healtheintent.com"}

Example response

{
  "id": "20556922-21e0-46dc-9224-7b914bb67b5d",
  "domain": "demo.cernerdemo.wellness.healtheintent.com"
}

POST /campaign-configs

Creates a campaign configuration for a specific domain.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created Created CampaignConfig
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Wellness User Enrollment Configuration

Wellness user enrollment configurations enable the customization of the steps that consumers complete to enroll in the Wellness Application service.

Retrieve a List of Wellness User Enrollment Configurations

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/wellness-user-enrollment-configs', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/wellness-user-enrollment-configs \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "cb6486e1-6972-4f5a-a1ec-b5e5c386745d",
      "domain": "demo.cernerdemo.wellness.us.healtheintent.com",
      "requiredFields": "DOB_AND_MEMBERID",
      "signupInstructions": [
        {
          "locale": "en-US",
          "content": "To sign up, you must accept the terms of use and be an active user."
        }
      ],
      "identifierFieldName": [
        {
          "locale": "en-US",
          "content": "User ID"
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/wellness-user-enrollment-configs?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/wellness-user-enrollment-configs?offset=0&limit=20"
}

GET /wellness-user-enrollment-configs

Retrieves all of the available wellness user enrollment configurations for a HealtheIntent tenant.

Parameters

Parameter In Type Required Default Description Accepted Values
domain query string false N/A Filters by the domain of the wellness user enrollment configurations. -
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 Success. WellnessUserEnrollmentConfigs
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Create a Wellness User Enrollment Configuration

Example Request:




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

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

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/wellness-user-enrollment-configs', headers: headers, body: {"domain":"demo.cernerdemo.wellness.us.healtheintent.com","requiredFields":"DOB_AND_MEMBERID","signupInstructions":[{"locale":"en-US","content":"To sign up, you must accept the terms of use and be an active user."}],"identifierFieldName":[{"locale":"en-US","content":"User ID"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/wellness-user-enrollment-configs \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"domain":"demo.cernerdemo.wellness.us.healtheintent.com","requiredFields":"DOB_AND_MEMBERID","signupInstructions":[{"locale":"en-US","content":"To sign up, you must accept the terms of use and be an active user."}],"identifierFieldName":[{"locale":"en-US","content":"User ID"}]}

POST /wellness-user-enrollment-configs

Creates a wellness user enrollment configuration for a HealtheIntent tenant.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created Created WellnessUserEnrollmentConfig
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Update a Wellness User Enrollment Configuration

Example Request:




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

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

result = HTTParty.put('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/wellness-user-enrollment-configs/cb6486e1-6972-4f5a-a1ec-b5e5c386745d', headers: headers, body: {"domain":"demo.cernerdemo.wellness.us.healtheintent.com","requiredFields":"DOB_AND_MEMBERID","signupInstructions":[{"locale":"en-US","content":"To sign up, you must accept the terms of use and be an active user."}],"identifierFieldName":[{"locale":"en-US","content":"User ID"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/wellness-user-enrollment-configs/cb6486e1-6972-4f5a-a1ec-b5e5c386745d \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"domain":"demo.cernerdemo.wellness.us.healtheintent.com","requiredFields":"DOB_AND_MEMBERID","signupInstructions":[{"locale":"en-US","content":"To sign up, you must accept the terms of use and be an active user."}],"identifierFieldName":[{"locale":"en-US","content":"User ID"}]}

PUT /wellness-user-enrollment-configs/{wellnessUserEnrollmentConfigId}

Updates a single wellness user enrollment configuration for a HealtheIntent tenant.

Parameters

Parameter In Type Required Default Description Accepted Values
wellnessUserEnrollmentConfigId path string true N/A The ID of the wellness user enrollment configuration. -
body body putWellnessUserEnrollmentConfigs true N/A No description -

Response Statuses

Status Meaning Description Schema
204 No Content Updated None
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Delete a Wellness User Enrollment Configuration

Example Request:


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

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

result = HTTParty.delete('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/wellness-user-enrollment-configs/cb6486e1-6972-4f5a-a1ec-b5e5c386745d', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/wellness-user-enrollment-configs/cb6486e1-6972-4f5a-a1ec-b5e5c386745d \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /wellness-user-enrollment-configs/{wellnessUserEnrollmentConfigId}

Deletes a single wellness user enrollment configuration for a HealtheIntent tenant.

Parameters

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

Response Statuses

Status Meaning Description Schema
204 No Content Deleted None
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Retrieve a Single Wellness User Enrollment Configuration

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/wellness-user-enrollment-configs/cb6486e1-6972-4f5a-a1ec-b5e5c386745d', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/wellness-user-enrollment-configs/cb6486e1-6972-4f5a-a1ec-b5e5c386745d \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

GET /wellness-user-enrollment-configs/{wellnessUserEnrollmentConfigId}

Retrieves a single wellness user enrollment configuration for a HealtheIntent tenant.

Parameters

Parameter In Type Required Default Description Accepted Values
wellnessUserEnrollmentConfigId path string true N/A The ID of the wellness user enrollment configuration. -

Response Statuses

Status Meaning Description Schema
200 OK Success WellnessUserEnrollmentConfig
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Wellness User Enrollment

Wellness user enrollment is the act of verifying a user for the first time and linking them to their individual portal.

Create Eligibility Records

Example Request:




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

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

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/eligibility-records', headers: headers, body: {"eligibilityRecords":[{"consumer":{"id":"d13cf066-0e21-40c7-bd9e-e19467b2c85e"},"dateOfBirth":"1996-02-28","familyName":"Smith","memberId":"38e3ac0d1221","telecoms":[{"system":"EMAIL","value":"jane.smith@rockhurst.edu"}]}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/eligibility-records \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"eligibilityRecords":[{"consumer":{"id":"d13cf066-0e21-40c7-bd9e-e19467b2c85e"},"dateOfBirth":"1996-02-28","familyName":"Smith","memberId":"38e3ac0d1221","telecoms":[{"system":"EMAIL","value":"jane.smith@rockhurst.edu"}]}]}

POST /eligibility-records

Creates multiple eligibility records. This allows tenants to set up users’ eligibility information. A maximum of 1000 eligibility records can be sent per request.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created Created. EligibilityRecordList
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Retrieve a List of Eligibility Records

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/eligibility-records', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "items": [
    {
      "id": "75323063-2b6d-4f80-b3ee-ab167d18c8b7",
      "consumer": {
        "id": "d13cf066-0e21-40c7-bd9e-e19467b2c85e"
      },
      "dateOfBirth": "1996-02-28",
      "familyName": "Smith",
      "memberId": "38e3ac0d1221",
      "telecoms": [
        {
          "system": "EMAIL",
          "value": "jane.smith@rockhurst.edu"
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/eligibility-records?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/eligibility-records?offset=0&limit=20"
}

GET /eligibility-records

Retrieves all of the eligibility records that meet the specified parameters. This can be used to verify a user’s identity.

Parameters

Parameter In Type Required Default Description Accepted Values
consumerId query string false N/A Filters by the ID of the consumer. -
telecom query string false N/A Filters by the system and value of the user’s telecom. Use a : to separate the system and value.
Note: The system and value must be URL-encoded, for example, ?telecom=EMAIL%3Auser%40cerner.com.
-
memberId query string false N/A Filters by the ID of the member. -
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 Success. EligibilityRecords
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Update an Eligibility Record

Example Request:




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

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

result = HTTParty.put('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/eligibility-records/75323063-2b6d-4f80-b3ee-ab167d18c8b7', headers: headers, body: {"consumer":{"id":"d13cf066-0e21-40c7-bd9e-e19467b2c85e"},"dateOfBirth":"1996-02-28","familyName":"Smith","memberId":"38e3ac0d1221","telecoms":[{"system":"EMAIL","value":"jane.smith@rockhurst.edu"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/eligibility-records/75323063-2b6d-4f80-b3ee-ab167d18c8b7 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"consumer":{"id":"d13cf066-0e21-40c7-bd9e-e19467b2c85e"},"dateOfBirth":"1996-02-28","familyName":"Smith","memberId":"38e3ac0d1221","telecoms":[{"system":"EMAIL","value":"jane.smith@rockhurst.edu"}]}

PUT /eligibility-records/{eligibilityRecordId}

Updates an eligibility record by ID.

Parameters

Parameter In Type Required Default Description Accepted Values
eligibilityRecordId path string true N/A The ID of the eligibility record. -
body body putEligibilityRecords true N/A No description -

Response Statuses

Status Meaning Description Schema
204 No Content Updated. None
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Delete an Eligibility Record

Example Request:


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

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

result = HTTParty.delete('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/eligibility-records/75323063-2b6d-4f80-b3ee-ab167d18c8b7', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/eligibility-records/75323063-2b6d-4f80-b3ee-ab167d18c8b7 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /eligibility-records/{eligibilityRecordId}

Deletes an eligibility record.

Parameters

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

Response Statuses

Status Meaning Description Schema
204 No Content Deleted. None
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Retrieve a Single Eligibility Record

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/eligibility-records/75323063-2b6d-4f80-b3ee-ab167d18c8b7', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/eligibility-records/75323063-2b6d-4f80-b3ee-ab167d18c8b7 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

GET /eligibility-records/{eligibilityRecordId}

Retrieves a single eligibility record by its ID. This can be used to retrieve information for a eligibility record.

Parameters

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

Response Statuses

Status Meaning Description Schema
200 OK Success. EligibilityRecord
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Retrieve a List of User Enrollments

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/user-enrollments', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "items": [
    {
      "id": "75323063-2b6d-4f80-b3ee-ab167d18c8b7",
      "telecoms": [
        {
          "system": "EMAIL",
          "value": "jane.smith@rockhurst.edu"
        }
      ],
      "completedUserEnrollment": {
        "id": "5ec08e15-1b70-46f5-9f9c-a91b33f310d1"
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/user-enrollments?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/user-enrollments?offset=0&limit=20"
}

GET /user-enrollments

Retrieves all of the available user enrollments that satisfy the filters.

Parameters

Parameter In Type Required Default Description Accepted Values
telecom query string false N/A Filters by the system and value of the user’s telecom. Use a : to separate the system and value.
Note: The system and value must be URL-encoded, for example, ?telecom=EMAIL%3Auser%40cerner.com.
-
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 Success. UserEnrollments
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Create a User Enrollment

Example Request:




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

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

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/user-enrollments', headers: headers, body: {"telecoms":[{"system":"EMAIL","value":"jane.smith@rockhurst.edu"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/user-enrollments \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"telecoms":[{"system":"EMAIL","value":"jane.smith@rockhurst.edu"}]}

POST /user-enrollments

Creates a user enrollment to start the enrollment process.
Note: This operation sends a verification code to the enrollment telecom.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created Created UserEnrollment
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Update a User Enrollment

Example Request:




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

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

result = HTTParty.put('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/user-enrollments/75323063-2b6d-4f80-b3ee-ab167d18c8b7', headers: headers, body: {"telecoms":[{"system":"EMAIL","value":"jane.smith@rockhurst.edu"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/user-enrollments/75323063-2b6d-4f80-b3ee-ab167d18c8b7 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"telecoms":[{"system":"EMAIL","value":"jane.smith@rockhurst.edu"}]}

PUT /user-enrollments/{userEnrollmentId}

Updates a user enrollment by its ID.

Parameters

Parameter In Type Required Default Description Accepted Values
userEnrollmentId path string true N/A The ID of the user enrollment. -
body body putUserEnrollments true N/A No description -

Response Statuses

Status Meaning Description Schema
204 No Content Updated None
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Retrieve a Single User Enrollment

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/user-enrollments/75323063-2b6d-4f80-b3ee-ab167d18c8b7', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/user-enrollments/75323063-2b6d-4f80-b3ee-ab167d18c8b7 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

GET /user-enrollments/{userEnrollmentId}

Retrieves a single user enrollment by its ID. This can be used to retrieve information for a user enrollment.

Parameters

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

Response Statuses

Status Meaning Description Schema
200 OK Success UserEnrollment
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Create a Verification Code

Example Request:


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

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

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/user-enrollments/75323063-2b6d-4f80-b3ee-ab167d18c8b7/verification-codes', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/user-enrollments/75323063-2b6d-4f80-b3ee-ab167d18c8b7/verification-codes \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

POST /user-enrollments/{userEnrollmentId}/verification-codes

Creates a new verification code, then sends the newly created code to the telecom.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created Created. VerificationCode
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Retrieve a List of Verification Codes

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/user-enrollments/75323063-2b6d-4f80-b3ee-ab167d18c8b7/verification-codes', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/user-enrollments/75323063-2b6d-4f80-b3ee-ab167d18c8b7/verification-codes \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "bfa7f5de-1d98-430c-8f61-68b2b9266b8f",
      "code": "IZKVO2"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/user-enrollments/:userEnrollmentId/verification-codes?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/user-enrollments/:userEnrollmentId/verification-codes?offset=0&limit=20"
}

GET /user-enrollments/{userEnrollmentId}/verification-codes

Retrieves the valid verification code. A verification code is valid if it meets the following requirements:
- The verification code is unused.
- The verification code is not expired. Verification codes expire 10 minutes after they are created.
- The verification code is the most recent verification code for a telecom. This means that each enrollment has at most one verification code.

Parameters

Parameter In Type Required Default Description Accepted Values
userEnrollmentId path string true N/A The ID of the user enrollment. -
code query string false N/A Filters by the verification code value. This is used to verify a code given by the user. -
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 Success. VerificationCodes
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Create Verified Personal Details

Example Request:




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

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

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/user-enrollments/75323063-2b6d-4f80-b3ee-ab167d18c8b7/verified-personal-details', headers: headers, body: {"verificationCode":"IZKVO2","memberId":"38e3ac0d1221","dateOfBirth":"1996-02-28","familyName":"Smith"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/user-enrollments/75323063-2b6d-4f80-b3ee-ab167d18c8b7/verified-personal-details \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"verificationCode":"IZKVO2","memberId":"38e3ac0d1221","dateOfBirth":"1996-02-28","familyName":"Smith"}

POST /user-enrollments/{userEnrollmentId}/verified-personal-details

Creates new verified personal details. The given personal details are verified against the user’s eligibility record. The given verification code is verified against the code sent to the user’s email. The memberId, dateOfBirth, and familyName fields may be required depending on the wellnessUserEnrollmentConfig field.

Parameters

Parameter In Type Required Default Description Accepted Values
userEnrollmentId path string true N/A The ID of the user enrollment. -
body body postUserEnrollmentsUserenrollmentidVerifiedPersonalDetails true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created Created. VerifiedPersonalDetails
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Retrieve a List of Verified Personal Details

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/user-enrollments/75323063-2b6d-4f80-b3ee-ab167d18c8b7/verified-personal-details', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/user-enrollments/75323063-2b6d-4f80-b3ee-ab167d18c8b7/verified-personal-details \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "memberId": "38e3ac0d1221",
      "dateOfBirth": "1996-02-28",
      "familyName": "Smith"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/user-enrollments/:userEnrollmentId/verified-personal-details?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/user-enrollments/:userEnrollmentId/verified-personal-details?offset=0&limit=20"
}

GET /user-enrollments/{userEnrollmentId}/verified-personal-details

Retrieves the verified personal details for an enrollment.

Parameters

Parameter In Type Required Default Description Accepted Values
userEnrollmentId path string true N/A The ID of the user enrollment. -
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 Success. VerifiedPersonalDetails
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Create a Failed Attempt

Example Request:


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

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

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/user-enrollments/75323063-2b6d-4f80-b3ee-ab167d18c8b7/failed-attempts', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/user-enrollments/75323063-2b6d-4f80-b3ee-ab167d18c8b7/failed-attempts \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

POST /user-enrollments/{userEnrollmentId}/failed-attempts

Creates a new failed attempt. This records that the enrolling user attempted to verify their identity and failed.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created Created. FailedAttempt
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Retrieve a List of Failed Attempts

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/user-enrollments/75323063-2b6d-4f80-b3ee-ab167d18c8b7/failed-attempts', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/user-enrollments/75323063-2b6d-4f80-b3ee-ab167d18c8b7/failed-attempts \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "createdAt": "2019-05-10T08:15:00"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/user-enrollments/:userEnrollmentId/failed-attempts?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/user-enrollments/:userEnrollmentId/failed-attempts?offset=0&limit=20"
}

GET /user-enrollments/{userEnrollmentId}/failed-attempts

Retrieves the failed attempts for the user enrollment. This can be used to limit the number of verification attempts by an enrolling user.

Parameters

Parameter In Type Required Default Description Accepted Values
userEnrollmentId path string true N/A The ID of the user enrollment. -
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 Success. FailedAttempts
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Retrieve a List of Completed User Enrollments

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/completed-user-enrollments', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/completed-user-enrollments \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "5ec08e15-1b70-46f5-9f9c-a91b33f310d1",
      "domain": "demo.cernerdemo.wellness.us.healtheintent.com",
      "identityProviderCredentials": {
        "entityId": "2.16.840.1.113883.4.6",
        "principal": "ca5e380f-8409-4fd9-b747-265d5e23984b"
      },
      "termsOfUseAcceptance": {
        "id": "09d87004-af98-4dbd-9177-95245f2fb67e"
      },
      "completedAt": "2019-04-02T08:00:00",
      "verifiedPersonalDetails": {
        "memberId": "38e3ac0d1221",
        "dateOfBirth": "1996-02-28",
        "familyName": "Smith"
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/completed-user-enrollments?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/completed-user-enrollments?offset=0&limit=20"
}

GET /completed-user-enrollments

Retrieves all of the completed user enrollments that satisfy the filters.

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 Success. CompletedUserEnrollments
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Create a Completed User Enrollment

Example Request:




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

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

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/completed-user-enrollments', headers: headers, body: {"identityProviderCredentials":{"entityId":"2.16.840.1.113883.4.6","principal":"ca5e380f-8409-4fd9-b747-265d5e23984b"},"termsOfUseAcceptance":{"id":"09d87004-af98-4dbd-9177-95245f2fb67e"},"domain":"demo.cernerdemo.wellness.us.healtheintent.com","userEnrollment":{"id":"75323063-2b6d-4f80-b3ee-ab167d18c8b7"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/completed-user-enrollments \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"identityProviderCredentials":{"entityId":"2.16.840.1.113883.4.6","principal":"ca5e380f-8409-4fd9-b747-265d5e23984b"},"termsOfUseAcceptance":{"id":"09d87004-af98-4dbd-9177-95245f2fb67e"},"domain":"demo.cernerdemo.wellness.us.healtheintent.com","userEnrollment":{"id":"75323063-2b6d-4f80-b3ee-ab167d18c8b7"}}

POST /completed-user-enrollments

Creates a completed user enrollment. This is the final step to enroll a user.
For a wellness enrollment, the enrollment must have verified personal details and a terms of use acceptance already created.
For a third-party enrollment, the user enrollment is not used.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created Created CompletedUserEnrollment
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Retrieve a Single Completed User Enrollment

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/completed-user-enrollments/5ec08e15-1b70-46f5-9f9c-a91b33f310d1', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/completed-user-enrollments/5ec08e15-1b70-46f5-9f9c-a91b33f310d1 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

GET /completed-user-enrollments/{completedUserEnrollmentId}

Retrieves a single completed user enrollment by its ID. This can be used to retrieve information for a completed user enrollment.

Parameters

Parameter In Type Required Default Description Accepted Values
completedUserEnrollmentId path string true N/A The ID of the completed user enrollment. -

Response Statuses

Status Meaning Description Schema
200 OK Success CompletedUserEnrollment
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Screening Configuration

Screening configurations enable you to configure focus areas for a specific data partition and population. Focus areas can be used to categorize areas of risk and align recommendations.

Retrieve a List of Focus Areas

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/screening-focus-areas', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/screening-focus-areas \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "da799f06-5f53-41cb-9335-4cd291b91578",
      "showRisk": "true",
      "riskType": {
        "code": "33851000175104",
        "system": "2.16.840.1.113883.6.96",
        "display": "Health status: tobacco use screening (observable entity)"
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/screening-focus-areas?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/screening-focus-areas?offset=0&limit=20"
}

GET /screening-focus-areas

Retrieves a list of the available focus areas for a HealtheIntent tenant.

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 Success. ScreeningFocusAreas
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Create a Focus Area

Example Request:




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

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

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/screening-focus-areas', headers: headers, body: {"showRisk":"true","riskType":{"code":"33851000175104","system":"2.16.840.1.113883.6.96","display":"Health status: tobacco use screening (observable entity)"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/screening-focus-areas \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"showRisk":"true","riskType":{"code":"33851000175104","system":"2.16.840.1.113883.6.96","display":"Health status: tobacco use screening (observable entity)"}}

POST /screening-focus-areas

Create a focus area for a HealtheIntent tenant.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created Created ScreeningFocusArea
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Retrieve a Single Focus Area

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/screening-focus-areas/7f48346e-3344-43e6-9e98-0443c3f9a5bf', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/screening-focus-areas/7f48346e-3344-43e6-9e98-0443c3f9a5bf \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

GET /screening-focus-areas/{screeningFocusAreaId}

Retrieves a single focus area for a HealtheIntent tenant.

Parameters

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

Response Statuses

Status Meaning Description Schema
200 OK Success ScreeningFocusArea
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Retrieve a List of Screening Configurations

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/screening-configs', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "items": [
    {
      "id": "da799f06-5f53-41cb-9335-4cd291b91578",
      "domain": "devhealtheintent.com",
      "population": {
        "id": "02ba8e56-c2ed-41f2-a440-ab4c24df65f4"
      },
      "dataPartition": {
        "id": "948929fd-7c5c-44ed-b028-f2b3549b9453"
      },
      "focusAreas": [
        {
          "id": "da799f06-5f53-41cb-9335-4cd291b91578",
          "showRisk": "true",
          "riskType": {
            "code": "33851000175104",
            "system": "2.16.840.1.113883.6.96",
            "display": "Health status: tobacco use screening (observable entity)"
          }
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/screening-configs?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/screening-configs?offset=0&limit=20"
}

GET /screening-configs

Retrieves a list of the available screening configurations for a HealtheIntent tenant.

Parameters

Parameter In Type Required Default Description Accepted Values
domain query string false N/A Filters by the domain. -
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 Success. ScreeningConfigs
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Create a Screening Configuration

Example Request:




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

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

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/screening-configs', headers: headers, body: {"domain":"devhealtheintent.com","population":{"id":"02ba8e56-c2ed-41f2-a440-ab4c24df65f4"},"dataPartition":{"id":"948929fd-7c5c-44ed-b028-f2b3549b9453"},"focusAreas":[{"id":"02ba8e56-c2ed-41f2-a440-ab4c24df65f4"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/screening-configs \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"domain":"devhealtheintent.com","population":{"id":"02ba8e56-c2ed-41f2-a440-ab4c24df65f4"},"dataPartition":{"id":"948929fd-7c5c-44ed-b028-f2b3549b9453"},"focusAreas":[{"id":"02ba8e56-c2ed-41f2-a440-ab4c24df65f4"}]}

POST /screening-configs

Creates a screening configuration for a HealtheIntent tenant.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created Created ScreeningConfig
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Delete a Screening Configuration

Example Request:


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

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

result = HTTParty.delete('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/screening-configs/7f48346e-3344-43e6-9e98-0443c3f9a5bf', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/screening-configs/7f48346e-3344-43e6-9e98-0443c3f9a5bf \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /screening-configs/{screeningConfigId}

Deletes a single screening configuration for a HealtheIntent tenant.

Parameters

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

Response Statuses

Status Meaning Description Schema
204 No Content Deleted None
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Update a Screening Configuration

Example Request:




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

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

result = HTTParty.put('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/screening-configs/7f48346e-3344-43e6-9e98-0443c3f9a5bf', headers: headers, body: {"domain":"devhealtheintent.com","population":{"id":"02ba8e56-c2ed-41f2-a440-ab4c24df65f4"},"dataPartition":{"id":"948929fd-7c5c-44ed-b028-f2b3549b9453"},"focusAreas":[{"id":"02ba8e56-c2ed-41f2-a440-ab4c24df65f4"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/screening-configs/7f48346e-3344-43e6-9e98-0443c3f9a5bf \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"domain":"devhealtheintent.com","population":{"id":"02ba8e56-c2ed-41f2-a440-ab4c24df65f4"},"dataPartition":{"id":"948929fd-7c5c-44ed-b028-f2b3549b9453"},"focusAreas":[{"id":"02ba8e56-c2ed-41f2-a440-ab4c24df65f4"}]}

PUT /screening-configs/{screeningConfigId}

Updates a single screening configuration for a HealtheIntent tenant.

Parameters

Parameter In Type Required Default Description Accepted Values
screeningConfigId path string true N/A The ID of the screening configuration. -
body body putScreeningConfigs true N/A No description -

Response Statuses

Status Meaning Description Schema
204 No Content Success None
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Retrieve a Single Screening Configuration

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/screening-configs/7f48346e-3344-43e6-9e98-0443c3f9a5bf', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/screening-configs/7f48346e-3344-43e6-9e98-0443c3f9a5bf \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

GET /screening-configs/{screeningConfigId}

Retrieves a single screening configuration for a HealtheIntent tenant.

Parameters

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

Response Statuses

Status Meaning Description Schema
200 OK Success ScreeningConfig
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Challenge Configuration

Challenge configurations enable building, presenting, and grouping challenge catalogs in the Wellness Application service.

Create a Challenge Configuration

Example Request:




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

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

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/challenge-configs', headers: headers, body: {"domain":"demo.cernerdemo.wellness.healtheintent.com","catalogs":[{"id":"f04034b5-80dc-4175-bcaf-66376576ee84"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/challenge-configs \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"domain":"demo.cernerdemo.wellness.healtheintent.com","catalogs":[{"id":"f04034b5-80dc-4175-bcaf-66376576ee84"}]}

Example response

{
  "id": "20556922-21e0-46dc-9224-7b914bb67b5d",
  "domain": "demo.cernerdemo.wellness.healtheintent.com",
  "catalogs": [
    {
      "id": "f04034b5-80dc-4175-bcaf-66376576ee84"
    }
  ]
}

POST /challenge-configs

Creates a new challenge configuration for a HealtheIntent tenant.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created Created ChallengeConfig
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Retrieve a List of Challenge Configurations

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/challenge-configs', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "items": [
    {
      "id": "20556922-21e0-46dc-9224-7b914bb67b5d",
      "domain": "demo.cernerdemo.wellness.healtheintent.com",
      "catalogs": [
        {
          "id": "f04034b5-80dc-4175-bcaf-66376576ee84"
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/wellness_application/v1/challenge-configs?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/wellness_application/v1/challenge-configs?offset=0&limit=20"
}

GET /challenge-configs

Retrieves all the available challenge configurations for a HealtheIntent tenant.

Parameters

Parameter In Type Required Default Description Accepted Values
domain query string false N/A Filters by the domain of the challenge configuration. -
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 Success ChallengeConfigs
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Update a Challenge Configuration

Example Request:




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

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

result = HTTParty.put('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/challenge-configs/9f48346e-3344-43e6-9e98-0443c3f9a5bg', headers: headers, body: {"domain":"demo.cernerdemo.wellness.healtheintent.com","catalogs":[{"id":"f04034b5-80dc-4175-bcaf-66376576ee84"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/challenge-configs/9f48346e-3344-43e6-9e98-0443c3f9a5bg \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"domain":"demo.cernerdemo.wellness.healtheintent.com","catalogs":[{"id":"f04034b5-80dc-4175-bcaf-66376576ee84"}]}

PUT /challenge-configs/{challengeConfigId}

Updates a single challenge configuration for a HealtheIntent tenant.

Parameters

Parameter In Type Required Default Description Accepted Values
challengeConfigId path string true N/A The ID of the challenge configuration. -
body body putChallengeConfigs true N/A No description -

Response Statuses

Status Meaning Description Schema
204 No Content Updated None
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Delete a Challenge Configuration

Example Request:


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

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

result = HTTParty.delete('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/challenge-configs/9f48346e-3344-43e6-9e98-0443c3f9a5bg', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/challenge-configs/9f48346e-3344-43e6-9e98-0443c3f9a5bg \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /challenge-configs/{challengeConfigId}

Deletes a single challenge configuration for a HealtheIntent tenant.

Parameters

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

Response Statuses

Status Meaning Description Schema
204 No Content Success None
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Retrieve a Single Challenge Configuration

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/challenge-configs/9f48346e-3344-43e6-9e98-0443c3f9a5bg', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/wellness-application/v1/challenge-configs/9f48346e-3344-43e6-9e98-0443c3f9a5bg \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "20556922-21e0-46dc-9224-7b914bb67b5d",
  "domain": "demo.cernerdemo.wellness.healtheintent.com",
  "catalogs": [
    {
      "id": "f04034b5-80dc-4175-bcaf-66376576ee84"
    }
  ]
}

GET /challenge-configs/{challengeConfigId}

Retrieves a single challenge configuration for a HealtheIntent tenant.

Parameters

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

Response Statuses

Status Meaning Description Schema
200 OK Success ChallengeConfig
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Schema Definitions

RiskAdvisors

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

RiskAdvisor

Name Type Required Description Accepted Values
id string true The ID of the risk advisor. -
description string true The description of the risk advisor. -
domain string true The site or domain with which the risk advisor is associated. -
populationId string true The ID of the HealtheIntent population with which the risk advisor is associated. -
dataPartitionId string true The ID of the HealtheIntent data partition that stores the data received by the platform. -
suggestionSetId string true The ID of the suggestion set with which the risk advisor is associated. -
type string true The type of the risk advisor. PHA, SCREENING

BadRequestError

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 [BadRequestErrorDetail] 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. -

BadRequestErrorDetail

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

UnauthorizedError

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 [UnauthorizedErrorDetail] false A list of additional error details. -

UnauthorizedErrorDetail

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

ForbiddenError

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 [ForbiddenErrorDetail] false A list of additional error details. -

ForbiddenErrorDetail

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

postRiskAdvisors

Name Type Required Description Accepted Values
description string true The description of the risk advisor. -
domain string true The site or domain with which the risk advisor is associated. -
populationId string true The ID of the HealtheIntent population with which the risk advisor is associated. -
dataPartitionId string true The ID of the HealtheIntent data partition that stores the data received by the platform. -
suggestionSetId string true The ID of the suggestion set with which the risk advisor is associated. The status of the suggestion set must be PUBLISHED. -
type string true The type of the risk advisor. PHA, SCREENING

NotFoundError

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 [NotFoundErrorDetail] false A list of additional error details. -

NotFoundErrorDetail

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

ConflictError

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 [ConflictErrorDetail] false A list of additional error details. -

ConflictErrorDetail

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

patchRiskAdvisors

Name Type Required Description Accepted Values
description string false The description of the risk advisor. -
domain string false The site or domain with which the risk advisor is associated. -
populationId string false The ID of the HealtheIntent population with which the risk advisor is associated. -
dataPartitionId string false The ID of the HealtheIntent data partition that stores the data received by the platform. -
suggestionSetId string false The ID of the suggestion set with which the risk advisor is associated. The status of the suggestion set must be PUBLISHED. -
type string false The type of the risk advisor. PHA, SCREENING

Suggestions

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

Suggestion

Name Type Required Description Accepted Values
id string true The ID of the suggestion. -
description string true Description of the suggestion. -
risk object true The risk criteria for the suggestion. -
longPlanTemplate object true The Longitudinal Plan template. -

postSuggestionSetsSuggestionsetidSuggestions

Name Type Required Description Accepted Values
description string true The description of the suggestion. -
risk object true The risk for the suggestion definition. -
» type object true The type of risk. -
»» code string true No description -
»» display string false No description -
»» system string true No description -
» method object true The method of the risk. -
»» code string true No description -
»» display string false No description -
»» system string true No description -
» interpretation string true The interpretation made based on the value of the risk. LOW_RISK_HIGH_BENEFIT, MODERATE_RISK_MODERATE_BENEFIT, HIGH_RISK_LOW_BENEFIT
longPlanTemplate object true The Longitudinal Plan template. -
» id string true The ID of the template associated with a suggestion definition. -

putSuggestionSetsSuggestionsetidSuggestions

Name Type Required Description Accepted Values
description string true The description of the suggestion. -
risk object true The risk for the suggestion definition. -
» type object true The type of risk. -
»» code string true No description -
»» display string false No description -
»» system string true No description -
» method object true The method of the risk. -
»» code string true No description -
»» display string false No description -
»» system string true No description -
» interpretation string true The interpretation made based on the value of the risk. LOW_RISK_HIGH_BENEFIT, MODERATE_RISK_MODERATE_BENEFIT, HIGH_RISK_LOW_BENEFIT
longPlanTemplate object true The Longitudinal Plan template. -
» id string true The ID of the template associated with a suggestion definition. -

postSuggestionSets

Name Type Required Description Accepted Values
description string true The description of the suggestion set. -
status string true The status of the suggestion set. The following statuses are possible, and the status can be updated only from DRAFT to PUBLISHED to RETIRED:
- DRAFT: Indicates that the suggestion set has not yet been published and can be updated.
- PUBLISHED: Indicates that the suggestion set can no longer be edited and can be associated with a risk advisor.
- RETIRED: Indicates that the suggestion set is no longer in use.
DRAFT, PUBLISHED, RETIRED

SuggestionSet

Name Type Required Description Accepted Values
id string true The ID of the suggestion set. -
description string true The description of the suggestion set. -
status string true The status of the suggestion set. The following statuses are possible, and the status can be updated only from DRAFT to PUBLISHED to RETIRED:
- DRAFT: Indicates that the suggestion set has not yet been published and can be updated.
- PUBLISHED: Indicates that the suggestion set can no longer be edited and can be associated with a risk advisor.
- RETIRED: Indicates that the suggestion set is no longer in use.
DRAFT, PUBLISHED, RETIRED

SuggestionSets

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

patchSuggestionSets

Name Type Required Description Accepted Values
description string true The description of the suggestion set. -
status string true The status of the suggestion set. The following statuses are possible, and the status can be updated only from DRAFT to PUBLISHED to RETIRED:
- DRAFT: Indicates that the suggestion set has not yet been published and can be updated.
- PUBLISHED: Indicates that the suggestion set can no longer be edited and can be associated with a risk advisor.
- RETIRED: Indicates that the suggestion set is no longer in use.
DRAFT, PUBLISHED, RETIRED

PublishedSuggestions

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

PublishedSuggestion

Name Type Required Description Accepted Values
type string true The type of the risk advisor. PHA, SCREENING
domain string true The site or domain with which the risk advisor is associated. -
description string true The description of the risk advisor. -
populationId string true The ID of the HealtheIntent population with which the risk advisor is associated. -
dataPartitionId string true The ID of the HealtheIntent data partition that stores the data received by the platform. -
suggestions [SuggestionGoal] true An array of suggestion definitions and goals. -

SuggestionGoal

Name Type Required Description Accepted Values
id string true The ID of the suggestion. -
longPlanTemplate LongPlanTemplate true The Longitudinal Plan template. -
risk Risk true The risk for the suggestion definition. -
goalDefinitions [GoalDefinition] true An array of goal definitions. -

LongPlanTemplate

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

Risk

Name Type Required Description Accepted Values
type Code true The type of the risk. -
method Code true The method of the risk. -
interpretation string true The interpretation made based on the value of the risk. LOW_RISK_HIGH_BENEFIT, MODERATE_RISK_MODERATE_BENEFIT, HIGH_RISK_LOW_BENEFIT

Code

Name Type Required Description Accepted Values
code string true The unique 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. -

GoalDefinition

Name Type Required Description Accepted Values
id string true The ID of the Longitudinal Plan goal definition. -
text string true The description of the goal definition. -
coding [Code] true The unique ID of the code from a coding system. -
activityDefinitions [ActivityDefinition] true An array of activity definitions. -

ActivityDefinition

Name Type Required Description Accepted Values
id string true The ID of the Longitudinal Plan activity definition. -
text string true The text of the activity definition. -
description string true The description of the activity definition -
coding Code true The unique Code for the activity definition. -

CampaignNotifications

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

CampaignNotification

Name Type Required Description Accepted Values
id string true The ID of the campaign notification. -
campaignId string true The ID of the wellness campaign. -
domain string true The domain with which the campaign configuration is associated. -
locale string true The locale of the campaign notification. -
notifiableEventName string true The name of the event for which the notification is configured to be sent. CAMPAIGN_BEGINNING, MID_CAMPAIGN, CAMPAIGN_ENDING_SOON
emailContent EmailContent false The content of the email. -
smsContent string false The text content of the SMS message. -
mobileContent MobileContent false The content of the mobile push notification. -
modalityFeatureFlags ModalityFeatureFlags false Representation of the modality feature flags. -
defaultNotificationPreferences DefaultNotificationPreferences false Representation of the default notification preferences to use if a consumer has not set preferences. -
sendNotificationOn string false The date on which the campaign notifications should be sent. -

EmailContent

Name Type Required Description Accepted Values
emailSubject string true The subject of the email. Either the emailContentHtml or emailContentPlaintext field is required to send email notifications. -
emailContentHtml string false The HTML content of the email. If this is present, emailSubject must also be present. -
emailContentPlaintext string false The plain text content of the email. If this is present, emailSubject must also be present. -

MobileContent

Name Type Required Description Accepted Values
mobilePushSubject string true The subject of the mobile push notification. -
mobilePushContent string true The text content of the mobile push notification. -

ModalityFeatureFlags

Name Type Required Description Accepted Values
emailEnabled boolean false Indicates whether email notifications are enabled. -
smsEnabled boolean false Indicates whether SMS notifications are enabled. -
mobilePushEnabled boolean false Indicates whether mobile push notifications are enabled. -

DefaultNotificationPreferences

Name Type Required Description Accepted Values
desiresEmail boolean false Indicates whether email notifications are desired. -
desiresSms boolean false Indicates whether SMS notifications are desired. -
desiresMobilePush boolean false Indicates whether mobile push notifications are desired. -

postCampaignConfigsCampaignconfigidNotifications

Name Type Required Description Accepted Values
locale string true The locale of the campaign notification. -
campaignId string true The ID of the wellness campaign. -
notifiableEventName string true The name of the event for which the notification is configured to be sent. CAMPAIGN_BEGINNING, MID_CAMPAIGN, CAMPAIGN_ENDING_SOON
smsContent string false The text content of the SMS message. -
emailContent EmailContent false The content of the email. -
mobileContent MobileContent false The content of the mobile push notification. -
modalityFeatureFlags ModalityFeatureFlags false Representation of the modality feature flags. -
defaultNotificationPreferences DefaultNotificationPreferences false Representation of the default notification preferences to use if a consumer has not set preferences. -
sendNotificationOn string false The date on which the campaign notifications should be sent. -

CampaignConfig

Name Type Required Description Accepted Values
id string true The ID of the campaign configuration. -
domain string true The domain with which the campaign configuration is associated. -

postCampaignConfigs

Name Type Required Description Accepted Values
domain string true The domain with which the campaign configuration is associated. -

EventConfigs

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

EventConfig

Name Type Required Description Accepted Values
id string true The ID of the event configuration. -
domain string true The domain name of the wellness application. -
catalogs [Catalog] true The catalogs that the wellness application can use. -

Catalog

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

postEventConfigs

Name Type Required Description Accepted Values
domain string true The domain name of the wellness application. -
catalogs [object] true The catalogs, or groups, of wellness events. -
» id string true The ID of the catalog. -

putEventConfigs

Name Type Required Description Accepted Values
domain string true The domain name of the wellness application. -
catalogs [object] true The catalogs, or groups, of wellness events. -
» id string true The ID of the catalog. -

PhaConfigs

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

PhaConfig

Name Type Required Description Accepted Values
id string true The ID of the PHA configuration. -
domain string true The domain name of the wellness application that uses the PHAs. -
phaDefinitions [PhaDefinitionReference] true A reference to the PHA definitions. -
phaFocusAreas [PhaFocusReference] true The list of PHA focus areas that are displayed in the wellness application. -

PhaDefinitionReference

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

PhaFocusReference

Name Type Required Description Accepted Values
id string true The ID of the PHA focus area. -

postPhaConfigs

Name Type Required Description Accepted Values
domain string true The domain name of the wellness application that uses the PHAs. -
phaDefinitions [object] true A reference to the PHA definition. -
» id string true The ID of the PHA definition. -
» locale string true The locale of the PHA. -
phaFocusAreas [object] false The list of PHA focus areas that are displayed in the wellness application. -
» id string true The ID of the PHA focus area. -

putPhaConfigs

Name Type Required Description Accepted Values
domain string true The domain name of the wellness application that uses the PHAs. -
phaDefinitions [object] true A reference to the PHA definition. -
» id string true The ID of the PHA definition. -
» locale string true The locale of the PHA. -
phaFocusAreas [object] false The list of PHA focus areas that are displayed in the wellness application. -
» id string true The ID of the PHA focus area. -

PhaFocusAreas

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

PhaFocusArea

Name Type Required Description Accepted Values
id string true The ID of the PHA focus area. -
phaSection PhaSectionReference true The PHA section associated with the PHA focus area. -
riskType RiskTypeReference true The type of the risk assessment associated with the PHA focus area. -

PhaSectionReference

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

RiskTypeReference

Name Type Required Description Accepted Values
id string true The ID of the risk type. -

postPhaFocusAreas

Name Type Required Description Accepted Values
phaSection object true The PHA section associated with the PHA focus area. -
» id string true The ID of the PHA section. -
» phaDefinitionId string true The ID of the PHA definition. -
riskType object true The type of the risk assessment associated with the PHA focus area. -
» id string true The ID of the risk type. -

postHealthTrackerConfigs

Name Type Required Description Accepted Values
domain string true The domain name of the wellness application. -
trackingMetric object true A reference to the tracking metric. -
» id string true The ID of the tracking metric. -

HealthTrackerConfig

Name Type Required Description Accepted Values
id string true The ID of the health tracker configuration. -
domain string true The domain name of the wellness application. -
trackingMetric TrackingMetricReference true A reference to the tracking metric. -

TrackingMetricReference

Name Type Required Description Accepted Values
id string true The ID of the tracking metric. -

HealthTrackerConfigSummaries

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

HealthTrackerConfigSummary

Name Type Required Description Accepted Values
id string true The ID of the health tracker configuration. -
domain string true The domain name of the wellness application that uses the health trackers. -
trackingMetric TrackingMetric true The tracking metric. -

TrackingMetric

Name Type Required Description Accepted Values
id string true The ID of the tracking metric. -
steps StepConfig true The configurations for tracking steps. -
physicalActivity PhysicalActivityConfig true The configurations for tracking physical activity. -
bloodPressure BloodPressureConfig true The configurations for tracking blood pressure. -
bloodGlucose BloodGlucoseConfig true The configurations for tracking blood glucose. -
weight WeightConfig true The configurations for tracking weight. -

StepConfig

Name Type Required Description Accepted Values
manualEntryEnabled boolean false Indicates whether manual entry is enabled. -
longPlanActivityDefinition LongPlanActivityDefinitionReference true A reference to the Longitudinal Plan activity definition that is associated with tracking steps. -

LongPlanActivityDefinitionReference

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

PhysicalActivityConfig

Name Type Required Description Accepted Values
manualEntryEnabled boolean false Indicates whether manual entry is enabled. -
longPlanActivityDefinition LongPlanActivityDefinitionReference true A reference to the Longitudinal Plan activity definition that is associated with tracking physical activity. -

BloodPressureConfig

Name Type Required Description Accepted Values
manualEntryEnabled boolean false Indicates whether manual entry is enabled. -

BloodGlucoseConfig

Name Type Required Description Accepted Values
manualEntryEnabled boolean false Indicates whether manual entry is enabled. -

WeightConfig

Name Type Required Description Accepted Values
manualEntryEnabled boolean false Indicates whether manual entry is enabled. -
longPlanActivityDefinition LongPlanActivityDefinitionReference true A reference to the Longitudinal Plan activity definition that is associated with tracking weight. -

putHealthTrackerConfigs

Name Type Required Description Accepted Values
domain string true The domain name of the wellness application. -
trackingMetric object true A reference to the tracking metric. -
» id string true The ID of the tracking metric. -

postTrackingMetrics

Name Type Required Description Accepted Values
steps object true The configurations for tracking steps. -
» longPlanActivityDefinition object true A reference to the Longitudinal Plan activity definition that is associated with tracking steps. -
»» id string true The ID of the Longitudinal Plan activity. -
» manualEntryEnabled boolean false Indicates whether manual entry is enabled. -
physicalActivity object true The configurations for tracking physical activity. -
» longPlanActivityDefinition object true A reference to the Longitudinal Plan activity definition that is associated with tracking physical activity. -
»» id string true The ID of the Longitudinal Plan activity. -
» manualEntryEnabled boolean false Indicates whether manual entry is enabled. -
bloodPressure object true The configurations for tracking blood pressure. -
» manualEntryEnabled boolean false Indicates whether manual entry is enabled. -
bloodGlucose object true The configurations for tracking blood glucose. -
» manualEntryEnabled boolean false Indicates whether manual entry is enabled. -
weight object true The configurations for tracking weight. -
» longPlanActivityDefinition object true A reference to the Longitudinal Plan activity definition that is associated with tracking weight. -
»» id string true The ID of the Longitudinal Plan activity. -
» manualEntryEnabled boolean false Indicates whether manual entry is enabled. -

TrackingMetrics

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

WellnessUserEnrollmentConfigs

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

WellnessUserEnrollmentConfig

Name Type Required Description Accepted Values
id string true The ID of the wellness user enrollment configuration. -
domain string true The domain name of the wellness application. -
requiredFields string true The required fields that a user must validate when they enroll. The following fields are allowed:
- DOB_AND_MEMBERID: The user must validate their date of birth and member ID.
- EMAIL_AND_DOB: The user must validate their email and date of birth.
- NAME_AND_MEMBERID: The user must validate their family name and member ID.
NAME_AND_MEMBERID, DOB_AND_MEMBERID, EMAIL_AND_DOB
signupInstructions [SignupInstructions] false The sign-up instructions that the wellness application displays. -
identifierFieldName [IdentifierFieldName] false The identifier field that the wellness application displays. If the requiredFields value is NAME_AND_MEMBERID or DOB_AND_MEMBERID, the identifierFieldName field is required. -

SignupInstructions

Name Type Required Description Accepted Values
locale string true The locale of the sign-up instructions. -
content string true The localized content of the sign-up instructions. -

IdentifierFieldName

Name Type Required Description Accepted Values
locale string true The locale of the identifier field name. -
content string true The localized content of the identifier field name. -

postWellnessUserEnrollmentConfigs

Name Type Required Description Accepted Values
domain string true The domain name of the wellness application. -
requiredFields string true The required fields that a user must validate when they enroll. The following fields are allowed:
- DOB_AND_MEMBERID: The user must validate their date of birth and member ID.
- EMAIL_AND_DOB: The user must validate their email and date of birth.
- NAME_AND_MEMBERID: The user must validate their family name and member ID.
-
signupInstructions [object] false The sign-up instructions that the wellness application displays. -
» locale string true The locale of the sign-up instructions. -
» content string true The localized content of the sign-up instructions. -
identifierFieldName [object] false The identifier field that the wellness application displays. If the requiredFields value is NAME_AND_MEMBERID or DOB_AND_MEMBERID, the identifierFieldName field is required. -
» locale string true The locale of the identifier field name. -
» content string true The localized content of the identifier field name. -

putWellnessUserEnrollmentConfigs

Name Type Required Description Accepted Values
domain string true The domain name of the wellness application. -
requiredFields string true The required fields that a user must validate when they enroll. The following fields are allowed:
- DOB_AND_MEMBERID: The user must validate their date of birth and member ID.
- EMAIL_AND_DOB: The user must validate their email and date of birth.
- NAME_AND_MEMBERID: The user must validate their family name and member ID.
-
signupInstructions [object] false The sign-up instructions that the wellness application displays. -
» locale string true The locale of the sign-up instructions. -
» content string true The localized content of the sign-up instructions. -
identifierFieldName [object] false The identifier field that the wellness application displays. If the requiredFields value is NAME_AND_MEMBERID or DOB_AND_MEMBERID, the identifierFieldName field is required. -
» locale string true The locale of the identifier field name. -
» content string true The localized content of the identifier field name. -

postEligibilityRecords

Name Type Required Description Accepted Values
eligibilityRecords [object] true A list of eligibility records. -
» consumer [object] true A reference to the consumer to which the eligibility record belongs. -
»» id string true The ID of the consumer. -
» memberId string true The tenant-configurable ID that uniquely identifies a user. This is used to verify the identity of the user. -
» dateOfBirth string true The date of birth of the user in ISO 8601 YYYY-MM-DD format. This is used to verify the identity of the user. -
» familyName string true The surname of the user. This is used to verify the identity of the user. -
» telecoms [object] false The contact details of the user. This is used to verify the identity of the user. -
»» system string true The system of the telecom. Currently, only EMAIL is supported. -
»» value string true The value of the telecom. -

EligibilityRecordList

Name Type Required Description Accepted Values
eligibility_records [EligibilityRecord] true A list of eligibility records. -

EligibilityRecord

Name Type Required Description Accepted Values
id string true The ID of the eligibility record. -
consumer ConsumerReference true A reference to the consumer to which the eligibility record belongs. -
dateOfBirth string true The date of birth of the user in ISO 8601 YYYY-MM-DD format. This is used to verify the identity of the user. -
familyName string true The surname of the user. This is used to verify the identity of the user. -
memberId string true The tenant-configurable ID that uniquely identifies a user. This is used to verify the identity of the user. -
telecoms [Telecom] false The contact details of the user. This is used to verify the identity of the user. -

ConsumerReference

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

Telecom

Name Type Required Description Accepted Values
system string true The system of the telecom. Currently, only EMAIL is supported. EMAIL
value string true The value of the telecom. -

EligibilityRecords

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

putEligibilityRecords

Name Type Required Description Accepted Values
consumer object true A reference to the consumer to which the eligibility record belongs. -
» id string true The ID of the consumer. -
dateOfBirth string true The date of birth of the user in ISO 8601 YYYY-MM-DD format. This is used to verify the identity of the user. -
familyName string true The surname of the user. This is used to verify the identity of the user. -
memberId string true The tenant-configurable ID that uniquely identifies a user. This is used to verify the identity of the user. -
telecoms [object] false The contact details of the user. This is used to verify the identity of the user. -
» system string true The system of the telecom. Currently, only EMAIL is supported. -
» value string true The value of the telecom. -

UserEnrollments

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

UserEnrollment

Name Type Required Description Accepted Values
id string true The ID of the user enrollment. -
telecoms [Telecom] true The contact details of the enrolling user. -
completedUserEnrollment CompletedUserEnrollmentReference false A completed user enrollment. -

CompletedUserEnrollmentReference

Name Type Required Description Accepted Values
id string true The ID of the completed user enrollment. -

postUserEnrollments

Name Type Required Description Accepted Values
telecoms [object] true The contact details of the enrolling user. -
» system string true The system of the telecom. Currently, only EMAIL is supported. -
» value string true The value of the telecom. -

putUserEnrollments

Name Type Required Description Accepted Values
telecoms [object] true The contact details of the enrolling user. -
» system string true The system of the telecom. Currently, only EMAIL is supported. -
» value string true The value of the telecom. -

VerificationCode

Name Type Required Description Accepted Values
id string true The ID of the verification code. -
code string true The value of the verification code. -

VerificationCodes

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

postUserEnrollmentsUserenrollmentidVerifiedPersonalDetails

Name Type Required Description Accepted Values
verificationCode string true The value of the verification code sent to the user. This must be a valid code. -
memberId string false The tenant-set ID of the user. -
dateOfBirth string false The date of birth of the user in ISO 8601 YYYY-MM-DD format. -
familyName string false The surname of the user. -

VerifiedPersonalDetails

Name Type Required Description Accepted Values
memberId string false The tenant-set ID of the user. -
dateOfBirth string false The date of birth of the user in ISO 8601 YYYY-MM-DD format. -
familyName string false The surname of the user. -

FailedAttempt

Name Type Required Description Accepted Values
createdAt string true The time when the failed attempt was created. -

FailedAttempts

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

CompletedUserEnrollments

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

CompletedUserEnrollment

Name Type Required Description Accepted Values
id string true The ID of the completed user enrollment. -
domain string true The domain with which the enrolled user is associated. -
identityProviderCredentials IdentityProviderCredentials true The enrolled user’s provisioned identity that is linked to the consumer record when it is enrolled. -
termsOfUseAcceptance TermsOfUseAcceptanceReference true The terms of use acceptance for the enrolled user. -
completedAt string true The completion time of the enrollment in ISO 8601 YYYY-MM-DDThh:mm:ss format. -
verifiedPersonalDetails VerifiedPersonalDetails false The personal details used to complete the enrollment. -

IdentityProviderCredentials

Name Type Required Description Accepted Values
entityId string true The ID of the entity used by the identity provider. -
principal string true The principal used by the identity provider. -

TermsOfUseAcceptanceReference

Name Type Required Description Accepted Values
id string true The ID of the terms of use acceptance. -

postCompletedUserEnrollments

Name Type Required Description Accepted Values
identityProviderCredentials object true The enrolled user’s provisioned identity that is linked to the consumer record when it is enrolled. -
» entityId string true The ID of the entity used by the identity provider. -
» principal string true The principal used by the identity provider. -
termsOfUseAcceptance object true The terms of use acceptance for the enrolled user. -
» id string true The ID of the terms of use acceptance. -
domain string true The domain with which the enrolled user is associated. -
userEnrollment object false The user enrollment that was completed. -
» id string true The ID of the user enrollment. -

ScreeningFocusAreas

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

ScreeningFocusArea

Name Type Required Description Accepted Values
id string true The ID of the focus area. -
showRisk boolean true Identifies whether the risk is shown. true indicates that the risk is shown, and false indicates that it is hidden. -
riskType RiskType true The risk type of the focus area. -

RiskType

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

postScreeningFocusAreas

Name Type Required Description Accepted Values
showRisk boolean false Identifies whether the risk is shown. true indicates that the risk is shown, and false indicates that it is hidden. -
riskType object true The risk type of the focus area. -
» code string true The code value of the risk type. -
» system string true The ID of the coding system that gives meaning to the code. -
» display string false A human-readable representation of the code. -

ScreeningConfigs

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

ScreeningConfig

Name Type Required Description Accepted Values
id string true The ID of the screening configuration. -
domain string true The value of the domain. -
population Population true The ID of the HealtheIntent population with which the screening configuration is associated. -
dataPartition DataPartition false The ID of the HealtheIntent data partition that stores the data received by the platform. -
focusAreas [ScreeningFocusArea] false The focus area configurations defined for the screening. -

Population

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

DataPartition

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

postScreeningConfigs

Name Type Required Description Accepted Values
domain string true The value of the domain. -
population object true The ID of the HealtheIntent population with which the screening configuration is associated. -
» id string true The unique ID of the population. -
dataPartition object false The ID of the HealtheIntent data partition that stores the data received by the platform. -
» id string true The unique ID of the data partition. -
focusAreas [object] false No description -
» id string true The unique ID of the focus area. -

putScreeningConfigs

Name Type Required Description Accepted Values
domain string true The value of the domain. -
population object true The ID of the HealtheIntent population with which the screening configuration is associated. -
» id string true The unique ID of the population. -
dataPartition object false The ID of the HealtheIntent data partition that stores the data received by the platform. -
» id string true The unique ID of the data partition. -
focusAreas [object] false No description -
» id string true The unique ID of the focus area. -

LearningModuleConfigs

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

LearningModuleConfig

Name Type Required Description Accepted Values
id string true The ID of the learning module configuration. -
domain string true The domain name of the wellness application. -
catalogs [Catalog] true The catalogs that the wellness application can use. -

postLearningModuleConfigs

Name Type Required Description Accepted Values
domain string true The domain name of the wellness application. -
catalogs [object] true The catalogs that the wellness application can use. -
» id string true The ID of the catalog. -

putLearningModuleConfigs

Name Type Required Description Accepted Values
domain string true The domain name of the wellness application. -
catalogs [object] true The catalogs that the wellness application can use. -
» id string true The ID of the catalog. -

postChallengeConfigs

Name Type Required Description Accepted Values
domain string true The domain with which the challenge configuration is associated. -
catalogs [object] true The IDs of the catalogs with which the challenge is associated. -
» id string true The ID of the challenge catalog. -

ChallengeConfig

Name Type Required Description Accepted Values
id string true The ID of the challenge configuration. -
domain string true The domain with which the challenge configuration is associated. -
catalogs [Catalog] true The IDs of the catalogs with which the challenge is associated. -

ChallengeConfigs

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

putChallengeConfigs

Name Type Required Description Accepted Values
domain string true The domain with which the challenge configuration is associated. -
catalogs [object] true The IDs of the catalogs with which the challenge is associated. -
» id string true The ID of the challenge catalog. -