Wellness Application API v1

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

URL: https://cernerdemo.api.us-1.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


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

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

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

print JSON.pretty_generate(result)


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

{
  "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-1.healtheintent.com/wellness-application/v1/risk-advisors?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.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	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a Risk Advisor




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/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-1.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"}

{
  "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	WellnessApplicationPublicApi_Entities_V1_Advisor_RiskAdvisor
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error
409	Conflict	Conflict	Error

Delete a Risk Advisor


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/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-1.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	Error
401	Unauthorized	Unauthorized	Error
404	Not Found	Not Found	Error

Update a Risk Advisor




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-1.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-1.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	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error
409	Conflict	Conflict	Error

Retrieve a Single Risk Advisor


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/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-1.healtheintent.com/wellness-application/v1/risk-advisors/11e8902c9e2908c69718f13503066bee \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "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	WellnessApplicationPublicApi_Entities_V1_Advisor_RiskAdvisor
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Suggestion Sets

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

Create a Suggestion Set




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/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-1.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"}

{
  "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	WellnessApplicationPublicApi_Entities_V1_Advisor_SuggestionSet
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error

Retrieve a List of Suggestion Sets


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

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

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

print JSON.pretty_generate(result)


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

{
  "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-1.healtheintent.com/wellness-application/v1/suggestion-sets?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.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	Error
401	Unauthorized	Unauthorized	Error

Update a Suggestion Set




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-1.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-1.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	None
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
404	Not Found	Not Found	Error

Retrieve a Single Suggestion Set


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/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-1.healtheintent.com/wellness-application/v1/suggestion-sets/11e8902c9e2908c69718f13503066bee \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "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	WellnessApplicationPublicApi_Entities_V1_Advisor_SuggestionSet
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
404	Not Found	Not Found	Error

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


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/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-1.healtheintent.com/wellness-application/v1/suggestion-sets/11e8902c9e2908c69718f13503066bee/suggestions \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "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-1.healtheintent.com/example/v1/examples?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/example/v1/examples?offset=0&limit=20"
}

GET /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	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Create a Suggestion




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/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-1.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"}}

{
  "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	WellnessApplicationPublicApi_Entities_V1_Advisor_Suggestion
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Delete a Suggestion


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/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-1.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 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
204	No Content	No Content	None
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Update a Suggestion




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

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

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/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-1.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

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	None
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Retrieve a Single Suggestion


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/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-1.healtheintent.com/wellness-application/v1/suggestion-sets/11e8902c9e2908c69718f13503066bee/suggestions/11e8902c9e2908c69718f13503066bee \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "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	WellnessApplicationPublicApi_Entities_V1_Advisor_Suggestion
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

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


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

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

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

print JSON.pretty_generate(result)


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

{
  "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",
      "suggestionSetId": "17c48b9b-934f-4d06-a750-f600d1f730db",
      "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"
                  },
                  "supportingReferences": [
                    {
                      "id": "ecb8026a-64f9-11e8-adc0-fa7ae01bbebc",
                      "kind": "wellness#learningModule"
                    }
                  ],
                  "supportingExternalReferences": [
                    {
                      "id": "ecb8026a-64f9-11e8-adc0-fa7ae01bbebc",
                      "system": "https://dev.healthwise.net/services/services.content/v1/articles/"
                    }
                  ]
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/example/v1/examples?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/example/v1/examples?offset=0&limit=20"
}

GET /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	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

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


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

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

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

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "6d743472-79ba-4f94-ba57-233ba8444a86",
      "domain": "demo.cernerdemo.wellness.us.healtheintent.com",
      "catalogs": [
        {
          "id": "f04034b5-80dc-4175-bcaf-66376576ee84"
        }
      ],
      "scopes": [
        {
          "id": "f8b6925f-23cb-4c6c-bb0d-1c197f833653"
        }
      ],
      "authorizedPersonnelGroups": [
        {
          "id": "20f8550d-bc01-4a62-9c32-1707ab943fa7"
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/event-configs?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.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 by the domain of the wellness application.	-
personnelGroupId	query	array[string]	false	N/A	Filters by the ID of the authorized personnel group.	-
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	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create an Event Configuration




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/event-configs', headers: headers, body: {"domain":"demo.cernerdemo.wellness.us.healtheintent.com","catalogs":[{"id":"f04034b5-80dc-4175-bcaf-66376576ee84"}],"scopes":[{"id":"f8b6925f-23cb-4c6c-bb0d-1c197f833653"}],"authorizedPersonnelGroups":[{"id":"20f8550d-bc01-4a62-9c32-1707ab943fa7"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.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"}],"scopes":[{"id":"f8b6925f-23cb-4c6c-bb0d-1c197f833653"}],"authorizedPersonnelGroups":[{"id":"20f8550d-bc01-4a62-9c32-1707ab943fa7"}]}

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	WellnessApplicationPublicApi_Entities_V1_Event_EventConfig
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Delete an Event Configuration


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/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-1.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	WellnessApplicationPublicApi_Entities_V1_Event_EventConfig
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Update an Event Configuration




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

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

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/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"}],"scopes":[{"id":"f8b6925f-23cb-4c6c-bb0d-1c197f833653"}],"authorizedPersonnelGroups":[{"id":"20f8550d-bc01-4a62-9c32-1707ab943fa7"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.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"}],"scopes":[{"id":"f8b6925f-23cb-4c6c-bb0d-1c197f833653"}],"authorizedPersonnelGroups":[{"id":"20f8550d-bc01-4a62-9c32-1707ab943fa7"}]}

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	WellnessApplicationPublicApi_Entities_V1_Event_EventConfig
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Retrieve a Single Event Configuration


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/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-1.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	WellnessApplicationPublicApi_Entities_V1_Event_EventConfig
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Education Configuration

Education configurations enable configuring education content for Wellness application domains.

Retrieve a List of Education Configurations


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

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

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

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "20556922-21e0-46dc-9224-7b914bb67b5d",
      "domain": "demo.cernerdemo.wellness.healtheintent.com",
      "catholicContentOnly": true
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/education-configs?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/education-configs?offset=0&limit=20"
}

GET /education-configs

Retrieves all of the available education 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 education configuration.	-
catholicContentOnly	query	boolean	false	N/A	Indicates whether only Catholic appropriate education content should be returned for a domain. If the value is `true`, only Catholic content is returned. If the value is `false`, all content is returned. Note: The default configuration is `false` and to return all available content.	-
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.	EducationConfigs
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create an Education Configuration




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

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

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

print JSON.pretty_generate(result)




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

POST /education-configs

Creates an education configuration for a HealtheIntent tenant.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
201	Created	Created	WellnessApplicationPublicApi_Entities_V1_Education_EducationConfig
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Delete an Education Configuration


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/education-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-1.healtheintent.com/wellness-application/v1/education-configs/f04034b5-80dc-4175-bcaf-66376576ee84 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /education-configs/{educationConfigId}

Deletes a single education configuration for a HealtheIntent tenant.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
204	No Content	Deleted	WellnessApplicationPublicApi_Entities_V1_Education_EducationConfig
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Update an Education Configuration




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

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

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/education-configs/f04034b5-80dc-4175-bcaf-66376576ee84', headers: headers, body: {"domain":"demo.cernerdemo.wellness.healtheintent.com","catholicContentOnly":true}.to_json )

print JSON.pretty_generate(result)




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

PUT /education-configs/{educationConfigId}

Updates a single education configuration for a HealtheIntent tenant.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
204	No Content	Updated	WellnessApplicationPublicApi_Entities_V1_Education_EducationConfig
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Retrieve a Single Education Configuration


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/education-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-1.healtheintent.com/wellness-application/v1/education-configs/f04034b5-80dc-4175-bcaf-66376576ee84 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

GET /education-configs/{educationConfigId}

Retrieves a single education configuration for a HealtheIntent tenant.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
200	OK	Success	WellnessApplicationPublicApi_Entities_V1_Education_EducationConfig
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

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


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/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-1.healtheintent.com/wellness-application/v1/learning-module-configs \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "6d743472-79ba-4f94-ba57-233ba8444a86",
      "domain": "demo.cernerdemo.wellness.us.healtheintent.com",
      "catalogs": [
        {
          "id": "f04034b5-80dc-4175-bcaf-66376576ee84"
        }
      ],
      "authorizedPersonnelGroups": [
        {
          "id": "20f8550d-bc01-4a62-9c32-1707ab943fa7"
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/learning-module-configs?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.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.	-
personnelGroupId	query	array[string]	false	N/A	Filters by the ID of the authorized personnel group.	-
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	Error
403	Forbidden	Forbidden	Error

Create a Learning Module Configuration




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/learning-module-configs', headers: headers, body: {"domain":"demo.cernerdemo.wellness.us.healtheintent.com","catalogs":[{"id":"f04034b5-80dc-4175-bcaf-66376576ee84"}],"authorizedPersonnelGroups":[{"id":"20f8550d-bc01-4a62-9c32-1707ab943fa7"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.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"}],"authorizedPersonnelGroups":[{"id":"20f8550d-bc01-4a62-9c32-1707ab943fa7"}]}

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	WellnessApplicationPublicApi_Entities_V1_LearningModule_LearningModuleConfig
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Delete a Learning Module Configuration


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/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-1.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	WellnessApplicationPublicApi_Entities_V1_LearningModule_LearningModuleConfig
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Update a Learning Module Configuration




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

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

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/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"}],"authorizedPersonnelGroups":[{"id":"20f8550d-bc01-4a62-9c32-1707ab943fa7"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.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"}],"authorizedPersonnelGroups":[{"id":"20f8550d-bc01-4a62-9c32-1707ab943fa7"}]}

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	WellnessApplicationPublicApi_Entities_V1_LearningModule_LearningModuleConfig
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Retrieve a Single Learning Module Configuration


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/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-1.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	WellnessApplicationPublicApi_Entities_V1_LearningModule_LearningModuleConfig
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

PHA Configuration

PHA configurations enable building and presenting PHAs, 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


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

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

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

print JSON.pretty_generate(result)


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

{
  "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"
      },
      "survey": {
        "id": "6d743472-79ba-4f94-ba57-233ba8444a86",
        "surveyDefinition": {
          "id": "2cfa3c40-acf0-43bc-ac76-8a7ec2b1baea",
          "type": "CHECKBOX",
          "subdomain": "healthelife"
        }
      },
      "authorizedPersonnelGroups": [
        {
          "id": "20f8550d-bc01-4a62-9c32-1707ab943fa7"
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/pha-configs?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.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.	-
personnelGroupId	query	array[string]	false	N/A	Filters by the ID of the authorized personnel group.	-
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	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a PHA Configuration




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/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"}],"survey":{"id":"d5db58c9-196c-449c-8af3-73770a4bcb25"},"authorizedPersonnelGroups":[{"id":"20f8550d-bc01-4a62-9c32-1707ab943fa7"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.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"}],"survey":{"id":"d5db58c9-196c-449c-8af3-73770a4bcb25"},"authorizedPersonnelGroups":[{"id":"20f8550d-bc01-4a62-9c32-1707ab943fa7"}]}

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	WellnessApplicationPublicApi_Entities_V1_PersonalHealthAssessment_PhaConfig
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Update a PHA Configuration




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

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

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/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"}],"survey":{"id":"d5db58c9-196c-449c-8af3-73770a4bcb25"},"authorizedPersonnelGroups":[{"id":"20f8550d-bc01-4a62-9c32-1707ab943fa7"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.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"}],"survey":{"id":"d5db58c9-196c-449c-8af3-73770a4bcb25"},"authorizedPersonnelGroups":[{"id":"20f8550d-bc01-4a62-9c32-1707ab943fa7"}]}

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	WellnessApplicationPublicApi_Entities_V1_PersonalHealthAssessment_PhaConfig
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Retrieve a Single PHA Configuration


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/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-1.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	WellnessApplicationPublicApi_Entities_V1_PersonalHealthAssessment_PhaConfig
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Retrieve a List of PHA Focus Areas


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/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-1.healtheintent.com/wellness-application/v1/pha-focus-areas \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "6d743472-79ba-4f94-ba57-233ba8444a86",
      "name": "Preventive health",
      "description": "Preventive Health focus area relates to the number and type of screenings and/or immunizations an individual, depending upon age and sex, has obtained as recommended by a health care team.",
      "phaSection": {
        "id": "da4cac69-462d-4e3e-8870-a39fad628354",
        "phaDefinitionId": "945e3db8-5fc8-4adb-81f1-d91fd7c8fd48"
      },
      "riskType": {
        "id": "da4cac69-462d-4e3e-8870-a39fad628354",
        "coding": {
          "code": "405079000",
          "system": "2.16.840.1.113883.6.96",
          "display": "Preventive Health"
        }
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/pha-focus-areas?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.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	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a PHA Focus Area




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/pha-focus-areas', headers: headers, body: {"name":"Preventive health","description":"Preventive Health focus area relates to the number and type of screenings and/or immunizations an individual, depending upon age and sex, has obtained as recommended by a health care team.","phaSection":{"id":"da4cac69-462d-4e3e-8870-a39fad628354","phaDefinitionId":"945e3db8-5fc8-4adb-81f1-d91fd7c8fd48"},"riskType":{"id":"a5bc14a0-78c3-47a4-828a-b61ff7ae61b8"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/pha-focus-areas \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Preventive health","description":"Preventive Health focus area relates to the number and type of screenings and/or immunizations an individual, depending upon age and sex, has obtained as recommended by a health care team.","phaSection":{"id":"da4cac69-462d-4e3e-8870-a39fad628354","phaDefinitionId":"945e3db8-5fc8-4adb-81f1-d91fd7c8fd48"},"riskType":{"id":"a5bc14a0-78c3-47a4-828a-b61ff7ae61b8"}}

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	WellnessApplicationPublicApi_Entities_V1_PersonalHealthAssessment_PhaFocusArea
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Retrieve a Single PHA Focus Area


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/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-1.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	WellnessApplicationPublicApi_Entities_V1_PersonalHealthAssessment_PhaFocusArea
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

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




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/health-tracker-configs', headers: headers, body: {"domain":"demo.cernerdemo.wellness.us.healtheintent.com","trackingMetric":{"id":"1c2b8b6d-c978-4223-a223-632f830f27d3"},"authorizedPersonnelGroups":[{"id":"20f8550d-bc01-4a62-9c32-1707ab943fa7"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.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"},"authorizedPersonnelGroups":[{"id":"20f8550d-bc01-4a62-9c32-1707ab943fa7"}]}

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.	WellnessApplicationPublicApi_Entities_V1_HealthTrackerConfig_HealthTrackerConfig
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Retrieve a List of Health Tracker Configurations


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/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-1.healtheintent.com/wellness-application/v1/health-tracker-configs \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "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"
          }
        }
      },
      "authorizedPersonnelGroups": [
        {
          "id": "20f8550d-bc01-4a62-9c32-1707ab943fa7"
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/health-tracker-configs?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.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.	-
personnelGroupId	query	array[string]	false	N/A	Filters by the ID of the authorized personnel group.	-
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	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Update a Health Tracker Configuration




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

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

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/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"},"authorizedPersonnelGroups":[{"id":"20f8550d-bc01-4a62-9c32-1707ab943fa7"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.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"},"authorizedPersonnelGroups":[{"id":"20f8550d-bc01-4a62-9c32-1707ab943fa7"}]}

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.	WellnessApplicationPublicApi_Entities_V1_HealthTrackerConfig_HealthTrackerConfig
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Retrieve a Single Health Tracker Configuration


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/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-1.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.	WellnessApplicationPublicApi_Entities_V1_HealthTrackerConfig_HealthTrackerConfigSummary
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Create a Tracking Metric




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/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-1.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.	WellnessApplicationPublicApi_Entities_V1_HealthTrackerConfig_TrackingMetric
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Retrieve a List of Tracking Metrics


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

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

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

print JSON.pretty_generate(result)


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

{
  "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-1.healtheintent.com/health-tracker-app/v1/tracking-metrics?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.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.	-
personnelGroupId	query	array[string]	false	N/A	Filters by the ID of the authorized personnel group.	-
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	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Retrieve a Single Tracking Metric


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/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-1.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.	WellnessApplicationPublicApi_Entities_V1_HealthTrackerConfig_TrackingMetric
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

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


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/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-1.healtheintent.com/wellness-application/v1/campaign-configs/11e8902c9e2908c69718f13503066bee/notifications \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "20556922-21e0-46dc-9224-7b914bb67b5d",
      "campaignId": "a4c5aebb-1afa-4d50-8cbf-41cbc2af419a",
      "domain": "demo.cernerdemo.wellness.healtheintent.com",
      "locale": "en-US",
      "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",
      "qualifiedConsumersCount": 2000,
      "createdAt": "2020-06-01T10:00:00.000Z",
      "updatedAt": "2020-06-07T10:00:00.000Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/example/v1/examples?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/example/v1/examples?offset=0&limit=20"
}

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

Response Statuses

Status	Meaning	Description	Schema
200	OK	Success	CampaignNotifications
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Create a Campaign Notification




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/campaign-configs/872fe01d-6539-45c3-b656-a7905baad46e/notifications', headers: headers, body: {"locale":"en-US","campaignId":"a4c5aebb-1afa-4d50-8cbf-41cbc2af419a","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-1.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","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"}

{
  "id": "20556922-21e0-46dc-9224-7b914bb67b5d",
  "campaignId": "a4c5aebb-1afa-4d50-8cbf-41cbc2af419a",
  "domain": "demo.cernerdemo.wellness.healtheintent.com",
  "locale": "en-US",
  "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",
  "qualifiedConsumersCount": 2000,
  "createdAt": "2020-06-01T10:00:00.000Z",
  "updatedAt": "2020-06-07T10:00:00.000Z"
}

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	WellnessApplicationPublicApi_Entities_V1_CampaignNotifications_CampaignNotification
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Update a Campaign Notification




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

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

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/campaign-configs/872fe01d-6539-45c3-b656-a7905baad46e/notifications/11e8902c9e2908c69718f13503066bee', headers: headers, body: {"locale":"en-US","campaignId":"a4c5aebb-1afa-4d50-8cbf-41cbc2af419a","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 PUT https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/campaign-configs/872fe01d-6539-45c3-b656-a7905baad46e/notifications/11e8902c9e2908c69718f13503066bee \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"locale":"en-US","campaignId":"a4c5aebb-1afa-4d50-8cbf-41cbc2af419a","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"}

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

Updates a campaign notification based on ID. 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
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.	-
body	body	putCampaignConfigsCampaignconfigidNotifications	true	N/A	No description	-

Response Statuses

Status	Meaning	Description	Schema
204	No Content	Updated	None
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Delete a Notification From a Campaign Configuration


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/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-1.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	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Campaign Configuration

Campaign configurations enable building, presenting, and associating campaigns with domains and notifications.

Retrieve a List of Campaign Configurations


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

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

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

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "20556922-21e0-46dc-9224-7b914bb67b5d",
      "domain": "demo.cernerdemo.wellness.healtheintent.com",
      "allowObjectiveCompletionRequestDetails": true,
      "authorizedPersonnelGroups": [
        {
          "id": "20f8550d-bc01-4a62-9c32-1707ab943fa7"
        }
      ],
      "campaigns": [
        {
          "id": "2904941-bc01-4a62-9c32-1707ab943fa7"
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/example/v1/examples?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/example/v1/examples?offset=0&limit=20"
}

GET /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.	-
allowObjectiveCompletionRequestDetails	query	boolean	false	N/A	Indicates whether consumers can submit additional information when they complete an objective for a wellness activity. If the value is `true`, they can. If the value is `false`, they cannot and an administrator will submit the additional information.	-
personnelGroupId	query	array[string]	false	N/A	Filters by the ID of the authorized personnel group.	-
campaignId	query	array[string]	false	N/A	Filters by the ID of the campaign.	-
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	WellnessApplicationPublicApi_Entities_V1_CampaignNotifications_CampaignConfig
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a Campaign Configuration




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/campaign-configs', headers: headers, body: {"domain":"demo.cernerdemo.wellness.healtheintent.com","allowObjectiveCompletionRequestDetails":true,"authorizedPersonnelGroups":[{"id":"20f8550d-bc01-4a62-9c32-1707ab943fa7"}],"campaigns":[{"id":"2904941-bc01-4a62-9c32-1707ab943fa7"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.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","allowObjectiveCompletionRequestDetails":true,"authorizedPersonnelGroups":[{"id":"20f8550d-bc01-4a62-9c32-1707ab943fa7"}],"campaigns":[{"id":"2904941-bc01-4a62-9c32-1707ab943fa7"}]}

{
  "id": "20556922-21e0-46dc-9224-7b914bb67b5d",
  "domain": "demo.cernerdemo.wellness.healtheintent.com",
  "allowObjectiveCompletionRequestDetails": true,
  "authorizedPersonnelGroups": [
    {
      "id": "20f8550d-bc01-4a62-9c32-1707ab943fa7"
    }
  ],
  "campaigns": [
    {
      "id": "2904941-bc01-4a62-9c32-1707ab943fa7"
    }
  ]
}

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	WellnessApplicationPublicApi_Entities_V1_CampaignNotifications_CampaignConfig
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Delete a Campaign Configuration


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/campaign-configs/20556922-21e0-46dc-9224-7b914bb67b5d', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/campaign-configs/20556922-21e0-46dc-9224-7b914bb67b5d \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /campaign-configs/{campaignConfigId}

Deletes a campaign configuration and its associated notification based on the configuration ID.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
204	No Content	No Content	None
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Update a Campaign Configuration




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

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

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/campaign-configs/20556922-21e0-46dc-9224-7b914bb67b5d', headers: headers, body: {"domain":"demo.cernerdemo.wellness.healtheintent.com","allowObjectiveCompletionRequestDetails":true,"authorizedPersonnelGroups":[{"id":"20f8550d-bc01-4a62-9c32-1707ab943fa7"}],"campaigns":[{"id":"2904941-bc01-4a62-9c32-1707ab943fa7"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/campaign-configs/20556922-21e0-46dc-9224-7b914bb67b5d \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"domain":"demo.cernerdemo.wellness.healtheintent.com","allowObjectiveCompletionRequestDetails":true,"authorizedPersonnelGroups":[{"id":"20f8550d-bc01-4a62-9c32-1707ab943fa7"}],"campaigns":[{"id":"2904941-bc01-4a62-9c32-1707ab943fa7"}]}

PUT /campaign-configs/{campaignConfigId}

Updates a single campaign configuration for a HealtheIntent tenant.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
204	No Content	Updated	WellnessApplicationPublicApi_Entities_V1_CampaignNotifications_CampaignConfig
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

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


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/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-1.healtheintent.com/wellness-application/v1/wellness-user-enrollment-configs \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "cb6486e1-6972-4f5a-a1ec-b5e5c386745d",
      "domain": "demo.cernerdemo.wellness.us.healtheintent.com",
      "requiredFields": "DOB_AND_MEMBERID",
      "onboardingEnabled": true,
      "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"
        }
      ],
      "authorizedPersonnelGroups": [
        {
          "id": "20f8550d-bc01-4a62-9c32-1707ab943fa7"
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/wellness-user-enrollment-configs?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.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.	-
personnelGroupId	query	array[string]	false	N/A	Filters by the ID of the authorized personnel group.	-
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	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a Wellness User Enrollment Configuration




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/wellness-user-enrollment-configs', headers: headers, body: {"domain":"demo.cernerdemo.wellness.us.healtheintent.com","requiredFields":"DOB_AND_MEMBERID","onboardingEnabled":true,"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"}],"authorizedPersonnelGroups":[{"id":"20f8550d-bc01-4a62-9c32-1707ab943fa7"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.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","onboardingEnabled":true,"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"}],"authorizedPersonnelGroups":[{"id":"20f8550d-bc01-4a62-9c32-1707ab943fa7"}]}

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	WellnessApplicationPublicApi_Entities_V1_WellnessUserEnrollment_WellnessUserEnrollmentConfig
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Update a Wellness User Enrollment Configuration




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

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

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/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","onboardingEnabled":true,"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"}],"authorizedPersonnelGroups":[{"id":"20f8550d-bc01-4a62-9c32-1707ab943fa7"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.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","onboardingEnabled":true,"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"}],"authorizedPersonnelGroups":[{"id":"20f8550d-bc01-4a62-9c32-1707ab943fa7"}]}

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	WellnessApplicationPublicApi_Entities_V1_WellnessUserEnrollment_WellnessUserEnrollmentConfig
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Delete a Wellness User Enrollment Configuration


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/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-1.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	WellnessApplicationPublicApi_Entities_V1_WellnessUserEnrollment_WellnessUserEnrollmentConfig
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Retrieve a Single Wellness User Enrollment Configuration


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/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-1.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	WellnessApplicationPublicApi_Entities_V1_WellnessUserEnrollment_WellnessUserEnrollmentConfig
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

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




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/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-1.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.	WellnessApplicationPublicApi_Entities_V1_WellnessUserEnrollment_EligibilityRecordList
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Retrieve a List of Eligibility Records


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

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

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

print JSON.pretty_generate(result)


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

{
  "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-1.healtheintent.com/wellness-application/v1/eligibility-records?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.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	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Update an Eligibility Record




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

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

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/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-1.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.	WellnessApplicationPublicApi_Entities_V1_WellnessUserEnrollment_EligibilityRecord
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Delete an Eligibility Record


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/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-1.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.	WellnessApplicationPublicApi_Entities_V1_WellnessUserEnrollment_EligibilityRecord
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Retrieve a Single Eligibility Record


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/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-1.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.	WellnessApplicationPublicApi_Entities_V1_WellnessUserEnrollment_EligibilityRecord
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Retrieve a List of User Enrollments


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

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

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

print JSON.pretty_generate(result)


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

{
  "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-1.healtheintent.com/wellness-application/v1/user-enrollments?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.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	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a User Enrollment




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/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-1.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	WellnessApplicationPublicApi_Entities_V1_WellnessUserEnrollment_UserEnrollment
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Update a User Enrollment




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

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

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/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-1.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	WellnessApplicationPublicApi_Entities_V1_WellnessUserEnrollment_UserEnrollment
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Retrieve a Single User Enrollment


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/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-1.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	WellnessApplicationPublicApi_Entities_V1_WellnessUserEnrollment_UserEnrollment
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Create a Verification Code


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

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

result = HTTParty.post('https://cernerdemo.api.us-1.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-1.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.	WellnessApplicationPublicApi_Entities_V1_WellnessUserEnrollment_VerificationCode
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Retrieve a List of Verification Codes


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/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-1.healtheintent.com/wellness-application/v1/user-enrollments/75323063-2b6d-4f80-b3ee-ab167d18c8b7/verification-codes \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "bfa7f5de-1d98-430c-8f61-68b2b9266b8f",
      "code": "IZKVO2"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/user-enrollments/:userEnrollmentId/verification-codes?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.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	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create Verified Personal Details




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/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-1.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.	WellnessApplicationPublicApi_Entities_V1_WellnessUserEnrollment_VerifiedPersonalDetails
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Retrieve a List of Verified Personal Details


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/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-1.healtheintent.com/wellness-application/v1/user-enrollments/75323063-2b6d-4f80-b3ee-ab167d18c8b7/verified-personal-details \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "memberId": "38e3ac0d1221",
      "dateOfBirth": "1996-02-28",
      "familyName": "Smith"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/user-enrollments/:userEnrollmentId/verified-personal-details?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.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	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a Failed Attempt


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

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

result = HTTParty.post('https://cernerdemo.api.us-1.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-1.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.	WellnessApplicationPublicApi_Entities_V1_WellnessUserEnrollment_FailedAttempt
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Retrieve a List of Failed Attempts


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/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-1.healtheintent.com/wellness-application/v1/user-enrollments/75323063-2b6d-4f80-b3ee-ab167d18c8b7/failed-attempts \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "createdAt": "2019-05-10T08:15:00"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/user-enrollments/:userEnrollmentId/failed-attempts?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.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	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Retrieve a List of Completed User Enrollments


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/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-1.healtheintent.com/wellness-application/v1/completed-user-enrollments \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "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-1.healtheintent.com/wellness-application/v1/completed-user-enrollments?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.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	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a Completed User Enrollment




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/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"},"consumer":{"id":"d13cf066-0e21-40c7-bd9e-e19467b2c85e"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.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"},"consumer":{"id":"d13cf066-0e21-40c7-bd9e-e19467b2c85e"}}

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	WellnessApplicationPublicApi_Entities_V1_WellnessUserEnrollment_CompletedUserEnrollment
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Retrieve a Single Completed User Enrollment


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/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-1.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	WellnessApplicationPublicApi_Entities_V1_WellnessUserEnrollment_CompletedUserEnrollment
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

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


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/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-1.healtheintent.com/wellness-application/v1/screening-focus-areas \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "da799f06-5f53-41cb-9335-4cd291b91578",
      "name": "Tobacco & Nicotine Exposure",
      "description": "Tobacco use is strongly linked to many forms of cancer. Tobacco and nicotine use and exposure can damage nearly every organ in the body, including the lungs, heart, blood vessels, reproductive organs, mouth, skin, eyes, and bones.",
      "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-1.healtheintent.com/wellness-application/v1/screening-focus-areas?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.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	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a Focus Area




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/screening-focus-areas', headers: headers, body: {"name":"Tobacco & Nicotine Exposure","description":"Tobacco use is strongly linked to many forms of cancer. Tobacco and nicotine use and exposure can damage nearly every organ in the body, including the lungs, heart, blood vessels, reproductive organs, mouth, skin, eyes, and bones.","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-1.healtheintent.com/wellness-application/v1/screening-focus-areas \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Tobacco & Nicotine Exposure","description":"Tobacco use is strongly linked to many forms of cancer. Tobacco and nicotine use and exposure can damage nearly every organ in the body, including the lungs, heart, blood vessels, reproductive organs, mouth, skin, eyes, and bones.","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	WellnessApplicationPublicApi_Entities_V1_ScreeningConfig_ScreeningFocusArea
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Retrieve a Single Focus Area


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/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-1.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	WellnessApplicationPublicApi_Entities_V1_ScreeningConfig_ScreeningFocusArea
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Retrieve a List of Screening Configurations


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

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

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

print JSON.pretty_generate(result)


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

{
  "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",
          "name": "Tobacco & Nicotine Exposure",
          "description": "Tobacco use is strongly linked to many forms of cancer. Tobacco and nicotine use and exposure can damage nearly every organ in the body, including the lungs, heart, blood vessels, reproductive organs, mouth, skin, eyes, and bones.",
          "showRisk": "true",
          "riskType": {
            "code": "33851000175104",
            "system": "2.16.840.1.113883.6.96",
            "display": "Health status: tobacco use screening (observable entity)"
          }
        }
      ],
      "authorizedPersonnelGroups": [
        {
          "id": "20f8550d-bc01-4a62-9c32-1707ab943fa7"
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/screening-configs?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.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.	-
personnelGroupId	query	array[string]	false	N/A	Filters by the ID of the authorized personnel group.	-
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	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a Screening Configuration




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/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"}],"authorizedPersonnelGroups":[{"id":"20f8550d-bc01-4a62-9c32-1707ab943fa7"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.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"}],"authorizedPersonnelGroups":[{"id":"20f8550d-bc01-4a62-9c32-1707ab943fa7"}]}

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	WellnessApplicationPublicApi_Entities_V1_ScreeningConfig_ScreeningConfig
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Delete a Screening Configuration


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/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-1.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	WellnessApplicationPublicApi_Entities_V1_ScreeningConfig_ScreeningConfig
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Update a Screening Configuration




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

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

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/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"}],"authorizedPersonnelGroups":[{"id":"20f8550d-bc01-4a62-9c32-1707ab943fa7"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.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"}],"authorizedPersonnelGroups":[{"id":"20f8550d-bc01-4a62-9c32-1707ab943fa7"}]}

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	WellnessApplicationPublicApi_Entities_V1_ScreeningConfig_ScreeningConfig
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Retrieve a Single Screening Configuration


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/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-1.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	WellnessApplicationPublicApi_Entities_V1_ScreeningConfig_ScreeningConfig
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Challenge Configuration

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

Create a Challenge Configuration




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/challenge-configs', headers: headers, body: {"domain":"demo.cernerdemo.wellness.healtheintent.com","catalogs":[{"id":"f04034b5-80dc-4175-bcaf-66376576ee84"}],"authorizedPersonnelGroups":[{"id":"20f8550d-bc01-4a62-9c32-1707ab943fa7"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.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"}],"authorizedPersonnelGroups":[{"id":"20f8550d-bc01-4a62-9c32-1707ab943fa7"}]}

{
  "id": "20556922-21e0-46dc-9224-7b914bb67b5d",
  "domain": "demo.cernerdemo.wellness.healtheintent.com",
  "catalogs": [
    {
      "id": "f04034b5-80dc-4175-bcaf-66376576ee84"
    }
  ],
  "authorizedPersonnelGroups": [
    {
      "id": "20f8550d-bc01-4a62-9c32-1707ab943fa7"
    }
  ]
}

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	WellnessApplicationPublicApi_Entities_V1_Challenges_ChallengeConfig
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Retrieve a List of Challenge Configurations


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

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

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

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "20556922-21e0-46dc-9224-7b914bb67b5d",
      "domain": "demo.cernerdemo.wellness.healtheintent.com",
      "catalogs": [
        {
          "id": "f04034b5-80dc-4175-bcaf-66376576ee84"
        }
      ],
      "authorizedPersonnelGroups": [
        {
          "id": "20f8550d-bc01-4a62-9c32-1707ab943fa7"
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/wellness_application/v1/challenge-configs?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.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.	-
personnelGroupId	query	array[string]	false	N/A	Filters by the ID of the authorized personnel group.	-
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	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Update a Challenge Configuration




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

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

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/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"}],"authorizedPersonnelGroups":[{"id":"20f8550d-bc01-4a62-9c32-1707ab943fa7"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.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"}],"authorizedPersonnelGroups":[{"id":"20f8550d-bc01-4a62-9c32-1707ab943fa7"}]}

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	WellnessApplicationPublicApi_Entities_V1_Challenges_ChallengeConfig
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Delete a Challenge Configuration


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/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-1.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	WellnessApplicationPublicApi_Entities_V1_Challenges_ChallengeConfig
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Retrieve a Single Challenge Configuration


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/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-1.healtheintent.com/wellness-application/v1/challenge-configs/9f48346e-3344-43e6-9e98-0443c3f9a5bg \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "20556922-21e0-46dc-9224-7b914bb67b5d",
  "domain": "demo.cernerdemo.wellness.healtheintent.com",
  "catalogs": [
    {
      "id": "f04034b5-80dc-4175-bcaf-66376576ee84"
    }
  ],
  "authorizedPersonnelGroups": [
    {
      "id": "20f8550d-bc01-4a62-9c32-1707ab943fa7"
    }
  ]
}

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	WellnessApplicationPublicApi_Entities_V1_Challenges_ChallengeConfig
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Survey Configuration

Survey configurations enable building, presenting, and grouping information used to reference surveys hosted by third-party survey vendors.

Retrieve a List of Survey Configurations


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

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

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

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "6d743472-79ba-4f94-ba57-233ba8444a86",
      "domain": "demo.cernerdemo.wellness.us.healtheintent.com",
      "surveyDefinition": {
        "id": "2cfa3c40-acf0-43bc-ac76-8a7ec2b1baea",
        "type": "CHECKBOX",
        "subdomain": "healthelife"
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/survey-configs?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/survey-configs?offset=0&limit=20"
}

GET /survey-configs

Retrieves all of the available survey 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.	-
surveyDefinitionId	query	string	false	N/A	Filters by the ID of the survey 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.	SurveyConfigs
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a Survey Configuration




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/survey-configs', headers: headers, body: {"domain":"demo.cernerdemo.wellness.us.healtheintent.com","surveyDefinition":{"id":"2cfa3c40-acf0-43bc-ac76-8a7ec2b1baea","type":"CHECKBOX","subdomain":"healthelife"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/survey-configs \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"domain":"demo.cernerdemo.wellness.us.healtheintent.com","surveyDefinition":{"id":"2cfa3c40-acf0-43bc-ac76-8a7ec2b1baea","type":"CHECKBOX","subdomain":"healthelife"}}

POST /survey-configs

Creates a new survey configuration for a HealtheIntent tenant.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
201	Created	Created	WellnessApplicationPublicApi_Entities_V1_Survey_SurveyConfig
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Update a Survey Configuration




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

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

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/survey-configs/dfbc49d2-725d-457e-9012-f2e0e80a886e', headers: headers, body: {"domain":"demo.cernerdemo.wellness.us.healtheintent.com","surveyDefinition":{"id":"2cfa3c40-acf0-43bc-ac76-8a7ec2b1baea","type":"CHECKBOX","subdomain":"healthelife"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/survey-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","surveyDefinition":{"id":"2cfa3c40-acf0-43bc-ac76-8a7ec2b1baea","type":"CHECKBOX","subdomain":"healthelife"}}

PUT /survey-configs/{surveyConfigId}

Updates a single survey configuration for a HealtheIntent tenant.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
204	No Content	Updated	WellnessApplicationPublicApi_Entities_V1_Survey_SurveyConfig
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Retrieve a Single Survey Configuration


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/survey-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-1.healtheintent.com/wellness-application/v1/survey-configs/dfbc49d2-725d-457e-9012-f2e0e80a886e \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

GET /survey-configs/{surveyConfigId}

Retrieves a single survey configuration for a HealtheIntent tenant.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
200	OK	Success	WellnessApplicationPublicApi_Entities_V1_Survey_SurveyConfig
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Objective Completion Request Forms

Objective completion request forms enable customizing the way objective completion requests are displayed to users when they submit the requests.

Retrieve a List of Objective Completion Request Forms


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/objective-completion-request-forms', headers: headers)

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "1a7444c9-a5de-47c6-9c31-40ac041224f8",
      "objective": {
        "id": "31d78870-d203-4831-8244-6390715626f5"
      },
      "fields": [
        {
          "id": "465c5a78-a98e-4224-9c83-64d47a4f5f5c",
          "required": false,
          "sequence": 1,
          "label": [
            {
              "locale": "en-US",
              "text": "Activity Description"
            }
          ]
        }
      ],
      "createdAt": "2019-11-05T18:45:00.000Z",
      "updatedAt": "2019-11-05T18:45:00.000Z",
      "proofOfObjectiveCompletion": {
        "display": "HIDDEN"
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/wellness/v1/objective-completion-request-forms?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/wellness/v1/objective-completion-request-forms?offset=0&limit=20"
}

GET /objective-completion-request-forms

Retrieves a list of all the objective completion request forms that satisfy the specified filters.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
objectiveId	query	string	false	N/A	Filters by the ID of an objective.	-
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	ObjectiveCompletionRequestForms
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create an Objective Completion Request Form




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/objective-completion-request-forms', headers: headers, body: {"objective":{"id":"31d78870-d203-4831-8244-6390715626f5"},"fields":[{"required":false,"sequence":1,"label":[{"locale":"en-US","text":"Activity Description"}]}],"proofOfObjectiveCompletion":{"display":"HIDDEN"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/objective-completion-request-forms \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"objective":{"id":"31d78870-d203-4831-8244-6390715626f5"},"fields":[{"required":false,"sequence":1,"label":[{"locale":"en-US","text":"Activity Description"}]}],"proofOfObjectiveCompletion":{"display":"HIDDEN"}}

{
  "id": "1a7444c9-a5de-47c6-9c31-40ac041224f8",
  "objective": {
    "id": "31d78870-d203-4831-8244-6390715626f5"
  },
  "fields": [
    {
      "id": "465c5a78-a98e-4224-9c83-64d47a4f5f5c",
      "required": false,
      "sequence": 1,
      "label": [
        {
          "locale": "en-US",
          "text": "Activity Description"
        }
      ]
    }
  ],
  "createdAt": "2019-11-05T18:45:00.000Z",
  "updatedAt": "2019-11-05T18:45:00.000Z",
  "proofOfObjectiveCompletion": {
    "display": "HIDDEN"
  }
}

POST /objective-completion-request-forms

Creates a form for submitting objective completion requests. Entries are displayed on forms for the activity description, provider name, and provider location fields only if labels are defined for them on the form.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
201	Created	Created	WellnessApplicationPublicApi_Entities_V1_ObjectiveCompletionRequestForm_ObjectiveCompletionRequestForm
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Update an Objective Completion Request Form




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

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

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/objective-completion-request-forms/1a7444c9-a5de-47c6-9c31-40ac041224f8', headers: headers, body: {"objective":{"id":"31d78870-d203-4831-8244-6390715626f5"},"fields":[{"id":"465c5a78-a98e-4224-9c83-64d47a4f5f5c","required":false,"sequence":1,"label":[{"locale":"en-US","text":"Activity Description"}]}],"proofOfObjectiveCompletion":{"display":"HIDDEN"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/objective-completion-request-forms/1a7444c9-a5de-47c6-9c31-40ac041224f8 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"objective":{"id":"31d78870-d203-4831-8244-6390715626f5"},"fields":[{"id":"465c5a78-a98e-4224-9c83-64d47a4f5f5c","required":false,"sequence":1,"label":[{"locale":"en-US","text":"Activity Description"}]}],"proofOfObjectiveCompletion":{"display":"HIDDEN"}}

PUT /objective-completion-request-forms/{objectiveCompletionRequestFormId}

Updates the objective completion request form with the given ID.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
objectiveCompletionRequestFormId	path	string	true	N/A	The ID of the objective completion request form.	-
body	body	putObjectiveCompletionRequestForms	true	N/A	No description	-

Response Statuses

Status	Meaning	Description	Schema
204	No Content	Updated	WellnessApplicationPublicApi_Entities_V1_ObjectiveCompletionRequestForm_ObjectiveCompletionRequestForm
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Delete an Objective Completion Request Form


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/objective-completion-request-forms/1a7444c9-a5de-47c6-9c31-40ac041224f8', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/objective-completion-request-forms/1a7444c9-a5de-47c6-9c31-40ac041224f8 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /objective-completion-request-forms/{objectiveCompletionRequestFormId}

Deletes the objective completion request form with the given ID.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
objectiveCompletionRequestFormId	path	string	true	N/A	The ID of the objective completion request form.	-

Response Statuses

Status	Meaning	Description	Schema
204	No Content	Deleted	WellnessApplicationPublicApi_Entities_V1_ObjectiveCompletionRequestForm_ObjectiveCompletionRequestForm
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Retrieve a Single Objective Completion Request Form


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/objective-completion-request-forms/1a7444c9-a5de-47c6-9c31-40ac041224f8', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/objective-completion-request-forms/1a7444c9-a5de-47c6-9c31-40ac041224f8 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "1a7444c9-a5de-47c6-9c31-40ac041224f8",
  "objective": {
    "id": "31d78870-d203-4831-8244-6390715626f5"
  },
  "fields": [
    {
      "id": "465c5a78-a98e-4224-9c83-64d47a4f5f5c",
      "required": false,
      "sequence": 1,
      "label": [
        {
          "locale": "en-US",
          "text": "Activity Description"
        }
      ]
    }
  ],
  "createdAt": "2019-11-05T18:45:00.000Z",
  "updatedAt": "2019-11-05T18:45:00.000Z",
  "proofOfObjectiveCompletion": {
    "display": "HIDDEN"
  }
}

GET /objective-completion-request-forms/{objectiveCompletionRequestFormId}

Retrieves the objective completion request form with the specified ID.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
objectiveCompletionRequestFormId	path	string	true	N/A	The ID of the objective completion request form.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	Success	WellnessApplicationPublicApi_Entities_V1_ObjectiveCompletionRequestForm_ObjectiveCompletionRequestForm
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Outreach Notifications

Outreach notifications are emails that are sent to the HealtheIntent consumers who are enrolled in the wellness site. Notifications can be sent to specific consumers based on their PHA status and can be configured to be sent on a specific date.

Create a PHA Email Notification




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/pha-email-notifications', headers: headers, body: {"domain":"demo.cernerdemo.wellness.healtheintent.com","phaResponseBeginsAfter":"2020-01-01","phaResponseEndsBefore":"2020-03-01","phaResponseStatus":"COMPLETED","locale":"en-US","emailSubject":"Reminder: Complete Your PHA!","emailBody":"<!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","sendNotificationOn":"2020-03-05"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/pha-email-notifications \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"domain":"demo.cernerdemo.wellness.healtheintent.com","phaResponseBeginsAfter":"2020-01-01","phaResponseEndsBefore":"2020-03-01","phaResponseStatus":"COMPLETED","locale":"en-US","emailSubject":"Reminder: Complete Your PHA!","emailBody":"<!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","sendNotificationOn":"2020-03-05"}

{
  "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
  "domain": "demo.cernerdemo.wellness.healtheintent.com",
  "phaResponseBeginsAfter": "2020-01-01",
  "phaResponseEndsBefore": "2020-11-30",
  "phaResponseStatus": "COMPLETED",
  "locale": "en-US",
  "emailSubject": "Reminder: Complete Your PHA!",
  "emailBody": "<!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",
  "sendNotificationOn": "2020-03-05",
  "notificationStatus": "NOT_SENT",
  "qualifiedConsumersCount": 2000,
  "createdAt": "2020-06-01T10:00:00.000Z",
  "updatedAt": "2020-06-07T10:00:00.000Z"
}

POST /pha-email-notifications

Creates a PHA email notification. PHA notifications are typically used when the content of the message is about reminding individuals to complete their PHA or learn about something that they can now do because they completed the PHA. Placeholders can be used to automatically personalize the content of the email. To add a placeholder, include it inside braces, for example, {{first_name}}. The supported placeholder values include first_name and last_name.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
201	Created	Created	WellnessApplicationPublicApi_Entities_V1_PhaNotifications_PhaEmailNotificationCreateResponse
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Retrieve a List of PHA Email Notifications


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

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

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

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
      "personalHealthAssessment": {
        "phaId": "0abf1d19-845f-44be-851e-5d9c08e58828"
      },
      "domain": "demo.cernerdemo.wellness.healtheintent.com",
      "phaResponseBeginsAfter": "2020-01-01",
      "phaResponseEndsBefore": "2020-11-30",
      "phaResponseStatus": "COMPLETED",
      "locale": "en-US",
      "emailSubject": "Reminder: Complete Your PHA!",
      "emailBody": "<!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",
      "sendNotificationOn": "2020-03-05",
      "notificationStatus": "NOT_SENT",
      "qualifiedConsumersCount": 2000,
      "createdAt": "2020-06-01T10:00:00.000Z",
      "updatedAt": "2020-06-07T10:00:00.000Z",
      "notificationProcessedAt": "2020-06-11T00:00:00.000Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/pha-email-notificationss?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/pha-email-notificationss?offset=0&limit=20"
}

GET /pha-email-notifications

Retrieves a list of PHA email notifications.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
domain	query	string	false	N/A	Filters the retrieved PHA email notifications by the domain with which they are associated.	-
notificationStatus	query	string	false	N/A	Filters the retrieved PHA email notifications by status.	SENT, IN_PROGRESS, NOT_SENT
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	PhaEmailNotifications
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Delete a PHA Email Notification


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/pha-email-notifications/1a857d33-5b74-4c76-9a60-a008ea652cc6', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/pha-email-notifications/1a857d33-5b74-4c76-9a60-a008ea652cc6 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /pha-email-notifications/{phaEmailNotificationId}

Deletes the PHA email notification with the specified ID. If the notification is already sent or is in progress, it cannot be deleted.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
204	No Content	Success	None
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Update a PHA Email Notification




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

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

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/pha-email-notifications/1a857d33-5b74-4c76-9a60-a008ea652cc6', headers: headers, body: {"domain":"demo.cernerdemo.wellness.healtheintent.com","phaResponseBeginsAfter":"2020-01-01","phaResponseEndsBefore":"2020-03-01","phaResponseStatus":"COMPLETED","locale":"en-US","emailSubject":"Reminder: Complete Your PHA!","emailBody":"<!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","sendNotificationOn":"2020-03-05"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/pha-email-notifications/1a857d33-5b74-4c76-9a60-a008ea652cc6 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"domain":"demo.cernerdemo.wellness.healtheintent.com","phaResponseBeginsAfter":"2020-01-01","phaResponseEndsBefore":"2020-03-01","phaResponseStatus":"COMPLETED","locale":"en-US","emailSubject":"Reminder: Complete Your PHA!","emailBody":"<!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","sendNotificationOn":"2020-03-05"}

PUT /pha-email-notifications/{phaEmailNotificationId}

Updates the PHA email notification with the specified ID using the specified data. If the notification is already sent, it can no longer be updated.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
phaEmailNotificationId	path	string	true	N/A	The ID of the PHA email notification.	-
body	body	putPhaEmailNotifications	true	N/A	No description	-

Response Statuses

Status	Meaning	Description	Schema
204	No Content	Success	WellnessApplicationPublicApi_Entities_V1_PhaNotifications_PhaEmailNotification
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Retrieve a Single PHA Email Notification


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/pha-email-notifications/1a857d33-5b74-4c76-9a60-a008ea652cc6', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/pha-email-notifications/1a857d33-5b74-4c76-9a60-a008ea652cc6 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
  "personalHealthAssessment": {
    "phaId": "0abf1d19-845f-44be-851e-5d9c08e58828"
  },
  "domain": "demo.cernerdemo.wellness.healtheintent.com",
  "phaResponseBeginsAfter": "2020-01-01",
  "phaResponseEndsBefore": "2020-11-30",
  "phaResponseStatus": "COMPLETED",
  "locale": "en-US",
  "emailSubject": "Reminder: Complete Your PHA!",
  "emailBody": "<!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",
  "sendNotificationOn": "2020-03-05",
  "notificationStatus": "NOT_SENT",
  "qualifiedConsumersCount": 2000,
  "createdAt": "2020-06-01T10:00:00.000Z",
  "updatedAt": "2020-06-07T10:00:00.000Z",
  "notificationProcessedAt": "2020-06-11T00:00:00.000Z"
}

GET /pha-email-notifications/{phaEmailNotificationId}

Retrieves a single PHA email notification by ID.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
200	OK	Success	WellnessApplicationPublicApi_Entities_V1_PhaNotifications_PhaEmailNotification
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Create an Email Notification




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/email-notifications', headers: headers, body: {"domain":"demo.cernerdemo.wellness.healtheintent.com","locale":"en-US","emailSubject":"New Portal Features","emailBody":"<!DOCTYPE html>\\n<html lang=\\\"en\\\">\\n <head>\\n <meta charset=\\\"utf-8\\\" />\\n <p> Hi {{first_name}},</p>\\n <p> <html>Check out the latest functionalities introduced in the portal to maintain your health and wellness</html>.</p>\\n","sendNotificationOn":"2020-03-05"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/email-notifications \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"domain":"demo.cernerdemo.wellness.healtheintent.com","locale":"en-US","emailSubject":"New Portal Features","emailBody":"<!DOCTYPE html>\\n<html lang=\\\"en\\\">\\n <head>\\n <meta charset=\\\"utf-8\\\" />\\n <p> Hi {{first_name}},</p>\\n <p> <html>Check out the latest functionalities introduced in the portal to maintain your health and wellness</html>.</p>\\n","sendNotificationOn":"2020-03-05"}

{
  "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
  "domain": "demo.cernerdemo.wellness.healtheintent.com",
  "locale": "en-US",
  "emailSubject": "New Portal Features",
  "emailBody": "<!DOCTYPE html>\\n<html lang=\\\"en\\\">\\n <head>\\n <meta charset=\\\"utf-8\\\" />\\n <p> Hi {{first_name}},</p>\\n <p> <html>Check out the latest functionalities introduced in the portal to maintain your health and wellness</html>.</p>\\n",
  "sendNotificationOn": "2020-03-05",
  "notificationStatus": "NOT_SENT",
  "qualifiedConsumersCount": 2000,
  "createdAt": "2020-06-01T10:00:00.000Z",
  "updatedAt": "2020-06-07T10:00:00.000Z",
  "notificationProcessedAt": "2020-06-11T00:00:00.000Z"
}

POST /email-notifications

Creates an email notification. Email notifications are typically used when the content of the messaging is broadly applicable and the administrator wants to send it to a large population. Placeholders can be used to automatically personalize the content of the email. To add a placeholder, include it inside braces, for example, {{first_name}}. The supported placeholders include first_name and last_name.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
201	Created	Created	WellnessApplicationPublicApi_Entities_V1_EmailNotifications_EmailNotification
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Retrieve a List of Email Notifications


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

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

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

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
      "domain": "demo.cernerdemo.wellness.healtheintent.com",
      "locale": "en-US",
      "emailSubject": "New Portal Features",
      "emailBody": "<!DOCTYPE html>\\n<html lang=\\\"en\\\">\\n <head>\\n <meta charset=\\\"utf-8\\\" />\\n <p> Hi {{first_name}},</p>\\n <p> <html>Check out the latest functionalities introduced in the portal to maintain your health and wellness</html>.</p>\\n",
      "sendNotificationOn": "2020-03-05",
      "notificationStatus": "NOT_SENT",
      "qualifiedConsumersCount": 2000,
      "createdAt": "2020-06-01T10:00:00.000Z",
      "updatedAt": "2020-06-07T10:00:00.000Z",
      "notificationProcessedAt": "2020-06-11T00:00:00.000Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/email-notifications?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/email-notifications?offset=0&limit=20"
}

GET /email-notifications

Retrieves a list of email notifications.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
domain	query	string	false	N/A	Filters the retrieved email notifications by the domain with which they are associated.	-
notificationStatus	query	string	false	N/A	Filters the retrieved email notifications by status.	SENT, IN_PROGRESS, NOT_SENT
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	EmailNotifications
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Delete an Email Notification


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/email-notifications/1a857d33-5b74-4c76-9a60-a008ea652cc6', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/email-notifications/1a857d33-5b74-4c76-9a60-a008ea652cc6 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /email-notifications/{emailNotificationId}

Deletes the email notification with the specified ID. If the notification is already sent or is in progress, it cannot be deleted.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
emailNotificationId	path	string	true	N/A	The ID of an email notification.	-

Response Statuses

Status	Meaning	Description	Schema
204	No Content	Success	None
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Update an Email Notification




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

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

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/email-notifications/1a857d33-5b74-4c76-9a60-a008ea652cc6', headers: headers, body: {"domain":"demo.cernerdemo.wellness.healtheintent.com","locale":"en-US","emailSubject":"New Portal Features","emailBody":"<!DOCTYPE html>\\n<html lang=\\\"en\\\">\\n <head>\\n <meta charset=\\\"utf-8\\\" />\\n <p> Hi {{first_name}},</p>\\n <p> <html>Check out the latest functionalities introduced in the portal to maintain your health and wellness</html>.</p>\\n","sendNotificationOn":"2020-03-05"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/email-notifications/1a857d33-5b74-4c76-9a60-a008ea652cc6 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"domain":"demo.cernerdemo.wellness.healtheintent.com","locale":"en-US","emailSubject":"New Portal Features","emailBody":"<!DOCTYPE html>\\n<html lang=\\\"en\\\">\\n <head>\\n <meta charset=\\\"utf-8\\\" />\\n <p> Hi {{first_name}},</p>\\n <p> <html>Check out the latest functionalities introduced in the portal to maintain your health and wellness</html>.</p>\\n","sendNotificationOn":"2020-03-05"}

PUT /email-notifications/{emailNotificationId}

Updates the email notification with the specified ID using the specified data. If the notification is already sent, it can no longer be updated.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
emailNotificationId	path	string	true	N/A	The ID of an email notification.	-
body	body	putEmailNotifications	true	N/A	No description	-

Response Statuses

Status	Meaning	Description	Schema
204	No Content	No Content	None
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Retrieve a Single Email Notification


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/email-notifications/1a857d33-5b74-4c76-9a60-a008ea652cc6', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/email-notifications/1a857d33-5b74-4c76-9a60-a008ea652cc6 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
  "domain": "demo.cernerdemo.wellness.healtheintent.com",
  "locale": "en-US",
  "emailSubject": "New Portal Features",
  "emailBody": "<!DOCTYPE html>\\n<html lang=\\\"en\\\">\\n <head>\\n <meta charset=\\\"utf-8\\\" />\\n <p> Hi {{first_name}},</p>\\n <p> <html>Check out the latest functionalities introduced in the portal to maintain your health and wellness</html>.</p>\\n",
  "sendNotificationOn": "2020-03-05",
  "notificationStatus": "NOT_SENT",
  "qualifiedConsumersCount": 2000,
  "createdAt": "2020-06-01T10:00:00.000Z",
  "updatedAt": "2020-06-07T10:00:00.000Z",
  "notificationProcessedAt": "2020-06-11T00:00:00.000Z"
}

GET /email-notifications/{emailNotificationId}

Retrieves a single email notification by ID.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
emailNotificationId	path	string	true	N/A	The ID of an email notification.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	Success	WellnessApplicationPublicApi_Entities_V1_EmailNotifications_EmailNotification
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Enroll Wellness Users

The Enroll Wellness Users endpoints enable adding or updating the consumer group and campaign for a consumer and creating an eligibility record for a consumer.

Create an Eligible User




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/enroll-wellness-users', headers: headers, body: {"consumer":{"id":"d13cf066-0e21-40c7-bd9e-e19467b2c85e"},"member":{"id":"d13cf066-0e21-40c7-bd9e-e19467b2c85e","group":"CER-MO"},"relationship":"PLAN_MEMBER","terminationDate":"2019-10-08","additionalInformation":[{"name":"companyDepartment","value":"Department of Education"}],"domain":"demo.cernerdemo.wellness.healtheintent.com","updatedBy":{"type":"ADMIN","id":"JSMITH"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/enroll-wellness-users \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"consumer":{"id":"d13cf066-0e21-40c7-bd9e-e19467b2c85e"},"member":{"id":"d13cf066-0e21-40c7-bd9e-e19467b2c85e","group":"CER-MO"},"relationship":"PLAN_MEMBER","terminationDate":"2019-10-08","additionalInformation":[{"name":"companyDepartment","value":"Department of Education"}],"domain":"demo.cernerdemo.wellness.healtheintent.com","updatedBy":{"type":"ADMIN","id":"JSMITH"}}

POST /enroll-wellness-users

Creates an eligible user. This allows tenants to add the user to a consumer group and campaign and create an eligibility record.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
201	Created	Created.	WellnessApplicationPublicApi_Entities_V1_EnrollWellnessUsers_EligibleUser
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Update an Eligible User




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

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

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/enroll-wellness-users/75323063-2b6d-4f80-b3ee-ab167d18c8b7', headers: headers, body: {"consumer":{"id":"d13cf066-0e21-40c7-bd9e-e19467b2c85e"},"member":{"id":"d13cf066-0e21-40c7-bd9e-e19467b2c85e","group":"CER-MO"},"relationship":"PLAN_MEMBER","terminationDate":"2019-10-08","additionalInformation":[{"name":"companyDepartment","value":"Department of Education"}],"domain":"demo.cernerdemo.wellness.healtheintent.com","updatedBy":{"type":"ADMIN","id":"JSMITH"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/enroll-wellness-users/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"},"member":{"id":"d13cf066-0e21-40c7-bd9e-e19467b2c85e","group":"CER-MO"},"relationship":"PLAN_MEMBER","terminationDate":"2019-10-08","additionalInformation":[{"name":"companyDepartment","value":"Department of Education"}],"domain":"demo.cernerdemo.wellness.healtheintent.com","updatedBy":{"type":"ADMIN","id":"JSMITH"}}

PUT /enroll-wellness-users/{eligibilityRecordId}

Updates the eligible user with the specified eligibility record ID. The consumer group and campaign are updated, and the eligibility record is updated with the latest information for the consumer.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
204	No Content	Updated.	WellnessApplicationPublicApi_Entities_V1_EnrollWellnessUsers_EligibleUser
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Vendor Reward Configurations

Vendor reward configurations associate a wellness application domain with the configuration of a reward vendor.

Create a Vendor Reward Configuration




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/vendor-reward-configs', headers: headers, body: {"domain":"cckc.wellness.healtheintent.com","vendorConfigId":"f9b1e5fa-c128-443c-9350-5e06ae5fb6e3"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/vendor-reward-configs \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"domain":"cckc.wellness.healtheintent.com","vendorConfigId":"f9b1e5fa-c128-443c-9350-5e06ae5fb6e3"}

{
  "id": "0cd17e2b-4552-4734-8894-1417eb21fda8",
  "vendorConfigId": "f9b1e5fa-c128-443c-9350-5e06ae5fb6e3",
  "domain": "cckc.wellness.healtheintent.com",
  "createdAt": "2019-11-05T18:45:00.000Z",
  "updatedAt": "2019-11-05T18:45:00.000Z"
}

POST /vendor-reward-configs

Creates a new vendor reward configuration.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
201	Created	Created	WellnessApplicationPublicApi_Entities_V1_Reward_VendorRewardConfig
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Retrieve a List of Vendor Reward Configurations


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

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

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

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "0cd17e2b-4552-4734-8894-1417eb21fda8",
      "vendorConfigId": "f9b1e5fa-c128-443c-9350-5e06ae5fb6e3",
      "domain": "cckc.wellness.healtheintent.com",
      "createdAt": "2019-11-05T18:45:00.000Z",
      "updatedAt": "2019-11-05T18:45:00.000Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/vendor-reward-configs?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/vendor-reward-configs?offset=0&limit=20"
}

GET /vendor-reward-configs

Retrieves a list of vendor reward configurations.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
domain	query	string	false	N/A	Filters the vendor reward configurations 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.	-
orderBy	query	string	false	updatedAt	A comma-separated list of fields by which to sort.	createdAt, updatedAt

Response Statuses

Status	Meaning	Description	Schema
200	OK	Success	VendorRewardConfigs
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Delete a Vendor Reward Configuration


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/vendor-reward-configs/ffe6a5d1-d8f7-44c7-a7a4-37ec99bcc925', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/vendor-reward-configs/ffe6a5d1-d8f7-44c7-a7a4-37ec99bcc925 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /vendor-reward-configs/{vendorRewardConfigId}

Deletes the vendor reward configuration with the specified ID.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
204	No Content	Success	None
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Update a Vendor Reward Configuration




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

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

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/vendor-reward-configs/ffe6a5d1-d8f7-44c7-a7a4-37ec99bcc925', headers: headers, body: {"domain":"cckc.wellness.healtheintent.com","vendorConfigId":"f9b1e5fa-c128-443c-9350-5e06ae5fb6e3"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/vendor-reward-configs/ffe6a5d1-d8f7-44c7-a7a4-37ec99bcc925 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"domain":"cckc.wellness.healtheintent.com","vendorConfigId":"f9b1e5fa-c128-443c-9350-5e06ae5fb6e3"}

PUT /vendor-reward-configs/{vendorRewardConfigId}

Updates the vendor reward configuration with the specified ID.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
vendorRewardConfigId	path	string	true	N/A	The ID of the vendor reward configuration.	-
body	body	putVendorRewardConfigs	true	N/A	No description	-

Response Statuses

Status	Meaning	Description	Schema
204	No Content	Updated	None
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Retrieve a Single Vendor Reward Configuration


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/vendor-reward-configs/ffadf1b7-b812-4eed-a769-f6a6c4c04b97', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/wellness-application/v1/vendor-reward-configs/ffadf1b7-b812-4eed-a769-f6a6c4c04b97 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "0cd17e2b-4552-4734-8894-1417eb21fda8",
  "vendorConfigId": "f9b1e5fa-c128-443c-9350-5e06ae5fb6e3",
  "domain": "cckc.wellness.healtheintent.com",
  "createdAt": "2019-11-05T18:45:00.000Z",
  "updatedAt": "2019-11-05T18:45:00.000Z"
}

GET /vendor-reward-configs/{vendorRewardConfigId}

Retrieves the vendor reward configuration with the specified ID.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
200	OK	Success	WellnessApplicationPublicApi_Entities_V1_Reward_VendorRewardConfig
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Schema Definitions

RiskAdvisors

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

WellnessApplicationPublicApi_Entities_V1_Advisor_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

Error

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

ErrorDetail

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

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.	-
type	string	true	The type of the risk advisor.	PHA, SCREENING

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	true	The ID of the suggestion set with which the risk advisor is associated.	-
type	string	false	The type of the risk advisor.	PHA, SCREENING

Suggestions

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

WellnessApplicationPublicApi_Entities_V1_Advisor_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 be associated with a risk advisor. - RETIRED: Indicates that the suggestion set is no longer in use.	DRAFT, PUBLISHED, RETIRED

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

WellnessApplicationPublicApi_Entities_V1_Advisor_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.	-
suggestionSetId	string	true	The ID of the suggestion set with which the risk advisor is associated.	-
suggestions	[WellnessApplicationPublicApi_Entities_V1_Advisor_SuggestionGoal]	true	An array of suggestion definitions and goals.	-

WellnessApplicationPublicApi_Entities_V1_Advisor_SuggestionGoal

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

WellnessApplicationPublicApi_Entities_V1_Advisor_LongPlanTemplate

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

WellnessApplicationPublicApi_Entities_V1_Advisor_Risk

Name	Type	Required	Description	Accepted Values
type	WellnessApplicationPublicApi_Entities_V1_Advisor_Code	true	The type of the risk.	-
method	WellnessApplicationPublicApi_Entities_V1_Advisor_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

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

WellnessApplicationPublicApi_Entities_V1_Advisor_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	[WellnessApplicationPublicApi_Entities_V1_Advisor_Code]	true	The unique ID of the code from a coding system.	-
activityDefinitions	[WellnessApplicationPublicApi_Entities_V1_Advisor_ActivityDefinition]	true	An array of activity definitions.	-

WellnessApplicationPublicApi_Entities_V1_Advisor_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	WellnessApplicationPublicApi_Entities_V1_Advisor_Code	true	The unique Code for the activity definition.	-
supportingReferences	[WellnessApplicationPublicApi_Entities_V1_Advisor_SupportingReference]	true	An array of supporting references.	-
supportingExternalReferences	[WellnessApplicationPublicApi_Entities_V1_Advisor_SupportingExternalReference]	true	An array of supporting external references.	-

WellnessApplicationPublicApi_Entities_V1_Advisor_SupportingReference

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

WellnessApplicationPublicApi_Entities_V1_Advisor_SupportingExternalReference

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the supporting external reference.	-
system	string	true	The type of the supporting external reference.	-

CampaignNotifications

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

WellnessApplicationPublicApi_Entities_V1_CampaignNotifications_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.	-
emailContent	WellnessApplicationPublicApi_Entities_V1_CampaignNotifications_EmailContent	false	The content of the email.	-
smsContent	string	false	The text content of the SMS message.	-
mobileContent	WellnessApplicationPublicApi_Entities_V1_CampaignNotifications_MobileContent	false	The content of the mobile push notification.	-
modalityFeatureFlags	WellnessApplicationPublicApi_Entities_V1_CampaignNotifications_ModalityFeatureFlags	false	Representation of the modality feature flags.	-
defaultNotificationPreferences	WellnessApplicationPublicApi_Entities_V1_CampaignNotifications_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.	-
qualifiedConsumersCount	integer(int32)	true	The total number of consumers who are qualified to receive the email. It is possible that not all qualified members will receive an email. The total number of qualified members may not be available immediately after the notification request is created. In such cases, a nil value is returned.	-
createdAt	string(date-time)	true	The date and time when the campaign notification request was created. In ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-
updatedAt	string(date-time)	true	The date and time when the campaign notification was last updated. In ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-

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

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

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

WellnessApplicationPublicApi_Entities_V1_CampaignNotifications_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.	-
smsContent	string	false	The text content of the SMS message.	-
emailContent	object	false	The content of the email.	-
» 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	object	false	The content of the mobile push notification.	-
» mobilePushSubject	string	true	The subject of the mobile push notification.	-
» mobilePushContent	string	true	The text content of the mobile push notification.	-
modalityFeatureFlags	object	false	Representation of the modality feature flags.	-
» emailEnabled	boolean	true	Indicates whether email notifications are enabled.	-
» smsEnabled	boolean	true	Indicates whether SMS notifications are enabled.	-
» mobilePushEnabled	boolean	true	Indicates whether mobile push notifications are enabled.	-
defaultNotificationPreferences	object	false	Representation of the default notification preferences to use if a consumer has not set preferences.	-
» desiresEmail	boolean	true	Indicates whether email notifications are desired.	-
» desiresSms	boolean	true	Indicates whether SMS notifications are desired.	-
» desiresMobilePush	boolean	true	Indicates whether mobile push notifications are desired.	-
sendNotificationOn	string	false	The date on which the campaign notifications should be sent.	-

putCampaignConfigsCampaignconfigidNotifications

Name	Type	Required	Description	Accepted Values
locale	string	true	The locale of the campaign notification.	-
campaignId	string	true	The ID of the wellness campaign.	-
smsContent	string	false	The text content of the SMS message.	-
emailContent	object	false	The content of the email.	-
» 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	object	false	The content of the mobile push notification.	-
» mobilePushSubject	string	true	The subject of the mobile push notification.	-
» mobilePushContent	string	true	The text content of the mobile push notification.	-
modalityFeatureFlags	object	false	Representation of the modality feature flags.	-
» emailEnabled	boolean	true	Indicates whether email notifications are enabled.	-
» smsEnabled	boolean	true	Indicates whether SMS notifications are enabled.	-
» mobilePushEnabled	boolean	true	Indicates whether mobile push notifications are enabled.	-
defaultNotificationPreferences	object	false	Representation of the default notification preferences to use if a consumer has not set preferences.	-
» desiresEmail	boolean	true	Indicates whether email notifications are desired.	-
» desiresSms	boolean	true	Indicates whether SMS notifications are desired.	-
» desiresMobilePush	boolean	true	Indicates whether mobile push notifications are desired.	-
sendNotificationOn	string	false	The date on which the campaign notifications should be sent.	-

WellnessApplicationPublicApi_Entities_V1_CampaignNotifications_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.	-
allowObjectiveCompletionRequestDetails	boolean	true	Indicates whether consumers can submit additional information when they complete an objective for a wellness activity. If the value is `true`, they can. If the value is `false`, they cannot and an administrator will submit the additional information.	-
authorizedPersonnelGroups	[WellnessApplicationPublicApi_Entities_V1_AuthorizedPersonnelGroup]	true	The personnel groups that are authorized to configure a campaign configuration.	-
campaigns	[WellnessApplicationPublicApi_Entities_V1_CampaignNotifications_CampaignIds]	true	Campaigns associated with the domain.	-

WellnessApplicationPublicApi_Entities_V1_AuthorizedPersonnelGroup

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the authorized personnel group.	-

WellnessApplicationPublicApi_Entities_V1_CampaignNotifications_CampaignIds

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

postCampaignConfigs

Name	Type	Required	Description	Accepted Values
domain	string	true	The domain with which the campaign configuration is associated.	-
allowObjectiveCompletionRequestDetails	boolean	true	Indicates whether consumers can submit additional information when they complete an objective for a wellness activity. If the value is `true`, they can. If the value is `false`, they cannot and an administrator will submit the additional information.	-
authorizedPersonnelGroups	[object]	false	The personnel groups that are authorized to configure campaign.	-
» id	string	true	The ID of the authorized personnel group.	-
campaigns	[string]	false	Campaigns associated with the domain and config.	-

putCampaignConfigs

Name	Type	Required	Description	Accepted Values
domain	string	true	The domain with which the campaign configuration is associated.	-
allowObjectiveCompletionRequestDetails	boolean	true	Indicates whether consumers can submit additional information when they complete an objective for a wellness activity. If the value is `true`, they can. If the value is `false`, they cannot and an administrator will submit the additional information.	-
authorizedPersonnelGroups	[object]	false	The personnel groups that are authorized to configure campaign.	-
» id	string	true	The ID of the authorized personnel group.	-
campaigns	[string]	false	Campaigns associated with the domain and config.	-

EventConfigs

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

WellnessApplicationPublicApi_Entities_V1_Event_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	[WellnessApplicationPublicApi_Entities_V1_Event_Catalog]	true	The catalogs that the wellness application can use.	-
scopes	[WellnessApplicationPublicApi_Entities_V1_Event_Scope]	false	The scopes that the wellness application can use.	-
authorizedPersonnelGroups	[WellnessApplicationPublicApi_Entities_V1_AuthorizedPersonnelGroup]	true	The personnel groups that are authorized to configure an event.	-

WellnessApplicationPublicApi_Entities_V1_Event_Catalog

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

WellnessApplicationPublicApi_Entities_V1_Event_Scope

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

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.	-
scopes	[object]	false	The scopes that the wellness application can use.	-
» id	string	true	The ID of the scope.	-
authorizedPersonnelGroups	[object]	false	The authorized personnel groups of wellness events.	-
» id	string	true	The ID of the authorized personnel group.	-

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.	-
scopes	[object]	false	The scopes that the wellness application can use.	-
» id	string	true	The ID of the scope.	-
authorizedPersonnelGroups	[object]	false	The authorized personnel groups of wellness events.	-
» id	string	true	The ID of the authorized personnel group.	-

PhaConfigs

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

WellnessApplicationPublicApi_Entities_V1_PersonalHealthAssessment_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	[WellnessApplicationPublicApi_Entities_V1_PersonalHealthAssessment_PhaDefinitionReference]	true	A reference to the PHA definitions.	-
phaFocusAreas	[WellnessApplicationPublicApi_Entities_V1_PersonalHealthAssessment_PhaFocusReference]	true	The list of PHA focus areas that are displayed in the wellness application.	-
survey	WellnessApplicationPublicApi_Entities_V1_Survey_SurveyConfigReference	false	The survey config that is associated with the PHA.	-
authorizedPersonnelGroups	[WellnessApplicationPublicApi_Entities_V1_AuthorizedPersonnelGroup]	true	The personnel groups that are authorized to configure the PHA.	-

WellnessApplicationPublicApi_Entities_V1_PersonalHealthAssessment_PhaDefinitionReference

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

WellnessApplicationPublicApi_Entities_V1_PersonalHealthAssessment_PhaFocusReference

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

WellnessApplicationPublicApi_Entities_V1_Survey_SurveyConfigReference

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the survey configuration.	-
surveyDefinition	WellnessApplicationPublicApi_Entities_V1_Survey_SurveyDefinitionReference	true	A reference to the survey definitions.	-

WellnessApplicationPublicApi_Entities_V1_Survey_SurveyDefinitionReference

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the survey definition.	-
type	string	true	The type (or vendor) of the survey.	CHECKBOX
subdomain	string	true	The subdomain of the Checkbox survey.	-

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.	-
survey	object	false	The survey config that is associated with the PHA.	-
» id	string	true	The ID of the survey configuration.	-
authorizedPersonnelGroups	[object]	false	The authorized personnel groups of the PHA.	-
» id	string	true	The ID of the authorized personnel group.	-

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.	-
survey	object	false	The survey config that is associated with the PHA.	-
» id	string	true	The ID of the survey configuration.	-
authorizedPersonnelGroups	[object]	false	The authorized personnel groups of the PHA.	-
» id	string	true	The ID of the authorized personnel group.	-

SurveyConfigs

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

WellnessApplicationPublicApi_Entities_V1_Survey_SurveyConfig

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the survey configuration.	-
domain	string	true	The domain of the wellness application.	-
surveyDefinition	WellnessApplicationPublicApi_Entities_V1_Survey_SurveyDefinitionReference	true	A reference to the survey definitions.	-

postSurveyConfigs

Name	Type	Required	Description	Accepted Values
domain	string	true	The domain of the wellness application.	-
surveyDefinition	object	true	A reference to the survey definitions.	-
» id	string	true	The ID of the survey definition.	-
» type	string	true	The type (or vendor) of the survey.	CHECKBOX
» subdomain	string	true	The subdomain of the Checkbox survey.	-

putSurveyConfigs

Name	Type	Required	Description	Accepted Values
domain	string	true	The domain of the wellness application.	-
surveyDefinition	object	true	A reference to the survey definitions.	-
» id	string	true	The ID of the survey definition.	-
» type	string	true	The type (or vendor) of the survey.	CHECKBOX
» subdomain	string	true	The subdomain of the Checkbox survey.	-

PhaFocusAreas

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

WellnessApplicationPublicApi_Entities_V1_PersonalHealthAssessment_PhaFocusArea

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the PHA focus area.	-
name	string	true	The name of the PHA focus area.	-
description	string	false	The description of the PHA focus area.	-
phaSection	WellnessApplicationPublicApi_Entities_V1_PersonalHealthAssessment_PhaSectionReference	true	The PHA section associated with the PHA focus area.	-
riskType	WellnessApplicationPublicApi_Entities_V1_PersonalHealthAssessment_RiskTypeReference	true	The type of the risk assessment associated with the PHA focus area.	-

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

WellnessApplicationPublicApi_Entities_V1_PersonalHealthAssessment_RiskTypeReference

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the risk type.	-
coding	WellnessApplicationPublicApi_Entities_V1_PersonalHealthAssessment_Code	true	The unique Code for the risk type.	-

WellnessApplicationPublicApi_Entities_V1_PersonalHealthAssessment_Code

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

postPhaFocusAreas

Name	Type	Required	Description	Accepted Values
name	string	false	The name of the PHA focus area.	-
description	string	false	The description of the PHA focus area.	-
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.	-

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.	-
authorizedPersonnelGroups	[object]	false	The personnel groups that are authorized to configure challenge.	-
» id	string	true	The ID of the authorized personnel group.	-

WellnessApplicationPublicApi_Entities_V1_HealthTrackerConfig_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	WellnessApplicationPublicApi_Entities_V1_HealthTrackerConfig_TrackingMetricReference	true	A reference to the tracking metric.	-
authorizedPersonnelGroups	[WellnessApplicationPublicApi_Entities_V1_AuthorizedPersonnelGroup]	true	The personnel groups that are authorized to configure the health tracker.	-

WellnessApplicationPublicApi_Entities_V1_HealthTrackerConfig_TrackingMetricReference

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

HealthTrackerConfigSummaries

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

WellnessApplicationPublicApi_Entities_V1_HealthTrackerConfig_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	WellnessApplicationPublicApi_Entities_V1_HealthTrackerConfig_TrackingMetric	true	The tracking metric.	-
authorizedPersonnelGroups	[WellnessApplicationPublicApi_Entities_V1_AuthorizedPersonnelGroup]	true	The personnel groups that are authorized to configure the health tracker summary.	-

WellnessApplicationPublicApi_Entities_V1_HealthTrackerConfig_TrackingMetric

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the tracking metric.	-
steps	WellnessApplicationPublicApi_Entities_V1_HealthTrackerConfig_StepConfig	true	The configurations for tracking steps.	-
physicalActivity	WellnessApplicationPublicApi_Entities_V1_HealthTrackerConfig_PhysicalActivityConfig	true	The configurations for tracking physical activity.	-
bloodPressure	WellnessApplicationPublicApi_Entities_V1_HealthTrackerConfig_BloodPressureConfig	true	The configurations for tracking blood pressure.	-
bloodGlucose	WellnessApplicationPublicApi_Entities_V1_HealthTrackerConfig_BloodGlucoseConfig	true	The configurations for tracking blood glucose.	-
weight	WellnessApplicationPublicApi_Entities_V1_HealthTrackerConfig_WeightConfig	true	The configurations for tracking weight.	-

WellnessApplicationPublicApi_Entities_V1_HealthTrackerConfig_StepConfig

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

WellnessApplicationPublicApi_Entities_V1_HealthTrackerConfig_LongPlanActivityDefinitionReference

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

WellnessApplicationPublicApi_Entities_V1_HealthTrackerConfig_PhysicalActivityConfig

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

WellnessApplicationPublicApi_Entities_V1_HealthTrackerConfig_BloodPressureConfig

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

WellnessApplicationPublicApi_Entities_V1_HealthTrackerConfig_BloodGlucoseConfig

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

WellnessApplicationPublicApi_Entities_V1_HealthTrackerConfig_WeightConfig

Name	Type	Required	Description	Accepted Values
manualEntryEnabled	boolean	false	Indicates whether manual entry is enabled.	-
longPlanActivityDefinition	WellnessApplicationPublicApi_Entities_V1_HealthTrackerConfig_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.	-
authorizedPersonnelGroups	[object]	false	The personnel groups that are authorized to configure challenge.	-
» id	string	true	The ID of the authorized personnel group.	-

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	[WellnessApplicationPublicApi_Entities_V1_HealthTrackerConfig_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	[WellnessApplicationPublicApi_Entities_V1_WellnessUserEnrollment_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.	-

WellnessApplicationPublicApi_Entities_V1_WellnessUserEnrollment_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
onboardingEnabled	boolean	true	Onboarding is enabled for this domain name	-
signupInstructions	[WellnessApplicationPublicApi_Entities_V1_WellnessUserEnrollment_SignupInstructions]	false	The sign-up instructions that the wellness application displays.	-
identifierFieldName	[WellnessApplicationPublicApi_Entities_V1_WellnessUserEnrollment_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.	-
authorizedPersonnelGroups	[WellnessApplicationPublicApi_Entities_V1_AuthorizedPersonnelGroup]	true	The personnel groups that are authorized to configure the user enrollment.	-

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

WellnessApplicationPublicApi_Entities_V1_WellnessUserEnrollment_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.	NAME_AND_MEMBERID, DOB_AND_MEMBERID, EMAIL_AND_DOB
onboardingEnabled	boolean	true	Onboarding is enabled for this domain name	-
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]	true	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.	-
authorizedPersonnelGroups	[object]	false	The personnel groups that are authorized to configure user enrollment.	-
» id	string	true	The ID of the authorized personnel group.	-

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.	NAME_AND_MEMBERID, DOB_AND_MEMBERID, EMAIL_AND_DOB
onboardingEnabled	boolean	true	Onboarding is enabled for this domain name	-
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]	true	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.	-
authorizedPersonnelGroups	[object]	false	The personnel groups that are authorized to configure user enrollment.	-
» id	string	true	The ID of the authorized personnel group.	-

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.	EMAIL
»» value	string	true	The value of the telecom.	-

WellnessApplicationPublicApi_Entities_V1_WellnessUserEnrollment_EligibilityRecordList

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

WellnessApplicationPublicApi_Entities_V1_WellnessUserEnrollment_EligibilityRecord

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the eligibility record.	-
consumer	WellnessApplicationPublicApi_Entities_V1_WellnessUserEnrollment_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	[WellnessApplicationPublicApi_Entities_V1_WellnessUserEnrollment_Telecom]	false	The contact details of the user. This is used to verify the identity of the user.	-

WellnessApplicationPublicApi_Entities_V1_WellnessUserEnrollment_ConsumerReference

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

WellnessApplicationPublicApi_Entities_V1_WellnessUserEnrollment_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	[WellnessApplicationPublicApi_Entities_V1_WellnessUserEnrollment_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.	EMAIL
» value	string	true	The value of the telecom.	-

UserEnrollments

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

WellnessApplicationPublicApi_Entities_V1_WellnessUserEnrollment_UserEnrollment

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

WellnessApplicationPublicApi_Entities_V1_WellnessUserEnrollment_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.	EMAIL
» 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.	EMAIL
» value	string	true	The value of the telecom.	-

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

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

VerifiedPersonalDetails

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

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

WellnessApplicationPublicApi_Entities_V1_WellnessUserEnrollment_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	WellnessApplicationPublicApi_Entities_V1_WellnessUserEnrollment_IdentityProviderCredentials	true	The enrolled user’s provisioned identity that is linked to the consumer record when it is enrolled.	-
termsOfUseAcceptance	WellnessApplicationPublicApi_Entities_V1_WellnessUserEnrollment_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	WellnessApplicationPublicApi_Entities_V1_WellnessUserEnrollment_VerifiedPersonalDetails	false	The personal details used to complete the enrollment.	-

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

WellnessApplicationPublicApi_Entities_V1_WellnessUserEnrollment_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. Exactly one of `userEnrollment` or `consumer` is required.	-
» id	string	true	The ID of the user enrollment.	-
consumer	object	false	A reference to the consumer to which the completed user enrollment belongs. Exactly one of `userEnrollment` or `consumer` is required.	-
» id	string	true	The ID of the consumer.	-

ScreeningFocusAreas

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

WellnessApplicationPublicApi_Entities_V1_ScreeningConfig_ScreeningFocusArea

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the focus area.	-
name	string	false	The name of the screening focus area.	-
description	string	false	The description of the screening 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	WellnessApplicationPublicApi_Entities_V1_ScreeningConfig_RiskType	true	The risk type of the focus area.	-

WellnessApplicationPublicApi_Entities_V1_ScreeningConfig_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
name	string	false	The name of the screening focus area.	-
description	string	false	The description of the screening focus area.	-
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	[WellnessApplicationPublicApi_Entities_V1_ScreeningConfig_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.	-

WellnessApplicationPublicApi_Entities_V1_ScreeningConfig_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	WellnessApplicationPublicApi_Entities_V1_ScreeningConfig_Population	true	The ID of the HealtheIntent population with which the screening configuration is associated.	-
dataPartition	WellnessApplicationPublicApi_Entities_V1_ScreeningConfig_DataPartition	false	The ID of the HealtheIntent data partition that stores the data received by the platform.	-
focusAreas	[WellnessApplicationPublicApi_Entities_V1_ScreeningConfig_ScreeningFocusArea]	false	The focus area configurations defined for the screening.	-
authorizedPersonnelGroups	[WellnessApplicationPublicApi_Entities_V1_AuthorizedPersonnelGroup]	true	The personnel groups that are authorized to configure a screening.	-

WellnessApplicationPublicApi_Entities_V1_ScreeningConfig_Population

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

WellnessApplicationPublicApi_Entities_V1_ScreeningConfig_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.	-
authorizedPersonnelGroups	[object]	false	The personnel groups that are authorized to configure screening.	-
» id	string	true	The ID of the authorized personnel group.	-

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.	-
authorizedPersonnelGroups	[object]	false	The personnel groups that are authorized to configure screening.	-
» id	string	true	The ID of the authorized personnel group.	-

LearningModuleConfigs

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

WellnessApplicationPublicApi_Entities_V1_LearningModule_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	[WellnessApplicationPublicApi_Entities_V1_LearningModule_Catalog]	true	The catalogs that the wellness application can use.	-
authorizedPersonnelGroups	[WellnessApplicationPublicApi_Entities_V1_AuthorizedPersonnelGroup]	true	The personnel groups that are authorized to configure the learning module.	-

WellnessApplicationPublicApi_Entities_V1_LearningModule_Catalog

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

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.	-
authorizedPersonnelGroups	[object]	false	The authorized personnel groups of learning modules.	-
» id	string	true	The ID of the authorized personnel group.	-

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.	-
authorizedPersonnelGroups	[object]	false	The authorized personnel groups of learning modules.	-
» id	string	true	The ID of the authorized personnel group.	-

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.	-
authorizedPersonnelGroups	[object]	false	The personnel groups that are authorized to configure challenge.	-
» id	string	true	The ID of the authorized personnel group.	-

WellnessApplicationPublicApi_Entities_V1_Challenges_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	[WellnessApplicationPublicApi_Entities_V1_Challenges_Catalog]	true	The IDs of the catalogs with which the challenge is associated.	-
authorizedPersonnelGroups	[WellnessApplicationPublicApi_Entities_V1_AuthorizedPersonnelGroup]	true	The personnel groups that are authorized to configure a challenge configuration.	-

WellnessApplicationPublicApi_Entities_V1_Challenges_Catalog

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

ChallengeConfigs

Name	Type	Required	Description	Accepted Values
items	[WellnessApplicationPublicApi_Entities_V1_Challenges_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.	-
authorizedPersonnelGroups	[object]	false	The personnel groups that are authorized to configure challenge.	-
» id	string	true	The ID of the authorized personnel group.	-

ObjectiveCompletionRequestForms

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

WellnessApplicationPublicApi_Entities_V1_ObjectiveCompletionRequestForm_ObjectiveCompletionRequestForm

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the objective completion request form.	-
objective	WellnessApplicationPublicApi_Entities_V1_ObjectiveCompletionRequestForm_ObjectiveCompletionRequestObjectiveReference	true	The objective to which the form settings apply.	-
fields	WellnessApplicationPublicApi_Entities_V1_ObjectiveCompletionRequestForm_ObjectiveCompletionRequestFormField	false	The form settings for the activity description.	-
createdAt	string	true	The time when the objective completion request form was created. In ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-
updatedAt	string	true	The time when the objective completion request form was last updated. In ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-
proofOfObjectiveCompletion	WellnessApplicationPublicApi_Entities_V1_ObjectiveCompletionRequestForm_ObjectiveCompletionRequestFormProof	false	Controls the display of the file upload interface for proofs of completion.	-

WellnessApplicationPublicApi_Entities_V1_ObjectiveCompletionRequestForm_ObjectiveCompletionRequestObjectiveReference

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

WellnessApplicationPublicApi_Entities_V1_ObjectiveCompletionRequestForm_ObjectiveCompletionRequestFormField

Name	Type	Required	Description	Accepted Values
id	string	true	The field’s ID.	-
required	boolean	false	Indicates whether to require the specified field on input forms. Defaults to `false`.	-
sequence	integer(int32)	true	The order in which the field should be rendered relative to other fields on the form. Field numbers begin at `1`.	-
label	WellnessApplicationPublicApi_Entities_V1_Translation	true	The label for the specified field.	-

WellnessApplicationPublicApi_Entities_V1_Translation

Name	Type	Required	Description	Accepted Values
locale	string	true	A two-letter language and two-letter region ID, for example, `en-US`. The locale should match the ISO 639-1 specification. See ISO 639 Language Codes on the ISO website for more information.	-
text	string	true	The text for the locale.	-

WellnessApplicationPublicApi_Entities_V1_ObjectiveCompletionRequestForm_ObjectiveCompletionRequestFormProof

Name	Type	Required	Description	Accepted Values
display	string	true	Indicates whether to allow proof of objective completions to be uploaded. Must be one of the following values: HIDDEN, OPTIONAL, REQUIRED.	-

postObjectiveCompletionRequestForms

Name	Type	Required	Description	Accepted Values
objective	object	true	The objective to which the form settings apply.	-
» id	string	true	The ID of the objective.	-
fields	[object]	false	Settings for the display of supporting information for this objective completion request form. Up to 3 fields can be specified.	-
» required	boolean	false	Indicates whether to require the specified field on input forms. Defaults to `false`.	-
» sequence	integer(int32)	true	The order in which the field should be rendered relative to other fields on the form. Field numbers begin at `1`.	1, 2, 3
» label	[object]	true	The form label for the specified field	-
»» locale	string	true	A two-letter language and two-letter region ID, for example, `en-US`. The locale should match the ISO 639-1 specification. See ISO 639 Language Codes on the ISO website for more information.	-
»» text	string	true	The text value of the field label for this locale. The maximum length is 191 characters.	-
proofOfObjectiveCompletion	object	false	Settings for displaying proof uploads for objective completion requests.	-
» display	string	true	Indicates whether to allow proof of objective completions to be uploaded. Must be one of the following values: HIDDEN, OPTIONAL, REQUIRED.	HIDDEN, OPTIONAL, REQUIRED

putObjectiveCompletionRequestForms

Name	Type	Required	Description	Accepted Values
objective	object	true	The objective to which the form settings apply.	-
» id	string	true	The ID of the objective.	-
fields	[object]	false	Settings for displaying supporting information for the objective completion request form. Up to 3 fields can be specified.	-
» id	string	false	The field’s ID.	-
» required	boolean	false	Indicates whether to require the specified field on input forms. Defaults to `false`.	-
» sequence	integer(int32)	true	The order in which the field should be rendered relative to other fields on the form. Field numbers begin at `1`.	-
» label	[object]	true	The form label for the specified field	-
»» locale	string	true	A two-letter language and two-letter region ID, for example, `en-US`. The locale should match the ISO 639-1 specification. See ISO 639 Language Codes on the ISO website for more information.	-
»» text	string	true	The text value of the field label for this locale. The maximum length is 191 characters.	-
proofOfObjectiveCompletion	object	false	Settings for displaying proof uploads for objective completion requests.	-
» display	string	true	Indicates whether to allow proof of objective completions to be uploaded. Must be one of the following values: HIDDEN, OPTIONAL, REQUIRED.	HIDDEN, OPTIONAL, REQUIRED

EducationConfigs

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

WellnessApplicationPublicApi_Entities_V1_Education_EducationConfig

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the education configuration.	-
domain	string	true	The domain with which the education configuration is associated.	-
catholicContentOnly	boolean	false	Indicates whether only Catholic appropriate education content should be returned for a domain. If the value is `true`, only Catholic content is returned. If the value is `false`, all content is returned. Note: The default configuration is `false` and to return all available content.	-

postEducationConfigs

Name	Type	Required	Description	Accepted Values
domain	string	true	The domain with which the education configuration is associated.	-
catholicContentOnly	boolean	false	Indicates whether only Catholic appropriate education content should be returned for a domain. If the value is `true`, only Catholic content is returned. If the value is `false`, all content is returned. Note: The default configuration is `false` and to return all available content.	-

putEducationConfigs

Name	Type	Required	Description	Accepted Values
domain	string	true	The domain with which the education configuration is associated.	-
catholicContentOnly	boolean	false	Indicates whether only Catholic appropriate education content should be returned for a domain. If the value is `true`, only Catholic content is returned. If the value is `false`, all content is returned. Note: The default configuration is `false` and to return all available content.	-

postPhaEmailNotifications

Name	Type	Required	Description	Accepted Values
domain	string	true	The domain with which the PHA email notification is associated.	-
phaResponseBeginsAfter	string	false	The date on or after which a consumer started the PHA response in ISO 8601 YYYY-MM-DD format. This value is used to filter the consumers for sending a notification when the request is processed. This date is relevant only for filtering the consumers who completed their PHA.	-
phaResponseEndsBefore	string	false	The date on or before which a consumer completed the PHA response in ISO 8601 YYYY-MM-DD format. This value is used to filter the consumers for sending a notification when the request is processed. This date is relevant only for filtering the consumers who completed their PHA.	-
phaResponseStatus	string	true	The status of the PHA response. The status is used to filter the list of consumers who are eligible to receive the email notification. The supported statuses include `NOT_STARTED`, `IN_PROGRESS`, and `COMPLETED`.	-
locale	string	true	The locale for which the PHA email notification is configured.	-
emailSubject	string	true	The subject of the email for PHA notification.	-
emailBody	string	true	The body of the email for PHA notification. The body is sent in HTML format.	-
sendNotificationOn	string	true	The date on which the PHA email notifications should be sent in ISO 8601 YYYY-MM-DD format. The date must be in the future.	-

WellnessApplicationPublicApi_Entities_V1_PhaNotifications_PhaEmailNotificationCreateResponse

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the PHA email notification.	-
domain	string	true	The domain with which the PHA email notification is associated.	-
phaResponseBeginsAfter	string	true	The date on or after which a consumer started the PHA response in ISO 8601 YYYY-MM-DD format. This value is used to filter the consumers for sending a notification when the request is processed. This date is relevant only for filtering the consumers who have completed their PHA.	-
phaResponseEndsBefore	string	true	The date on or before which a consumer completed the PHA response in ISO 8601 YYYY-MM-DD format. This value is used to filter the consumers for sending a notification when the request is processed. This date is relevant only for filtering the consumers who have completed their PHA.	-
phaResponseStatus	string	true	The status of the PHA response. The status is used to filter the list of consumers who are eligible to receive the email notification. The supported status values include `NOT_STARTED`, `IN_PROGRESS`, and `COMPLETED`.	NOT_STARTED, IN_PROGRESS, COMPLETED
locale	string	true	The locale for which this PHA email notification is configured.	-
emailSubject	string	true	The subject of the email for PHA notification.	-
emailBody	string	true	The body of the email for PHA notification. The body is sent in HTML format.	-
sendNotificationOn	string(date)	true	The date on which the PHA email notifications should be sent in ISO 8601 YYYY-MM-DD format. If this date is not provided, the notification is sent within the next 24 hours.	-
notificationStatus	string	true	The current status of a particular PHA email notification. The default status value is `NOT_SENT`. The supported status values include `NOT_SENT`, `SENDING`, and `SENT`.	-
qualifiedConsumersCount	integer(int32)	true	The total number of consumers that satisfy the criteria based on the `phaResponseBeginsAfter`, `phaResponseEndsBefore`, and `phaResponseStatus` values. It is possible that not all qualified members will receive an email. The total number of qualified members may not be available immediately after creating the notification request. In such cases, a nil value is returned.	-
createdAt	string(date-time)	true	The date and time when the PHA email notification request was created in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-
updatedAt	string(date-time)	true	The date and time when the PHA email notification was last updated in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-

PhaEmailNotifications

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

WellnessApplicationPublicApi_Entities_V1_PhaNotifications_PhaEmailNotification

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the PHA email notification.	-
personalHealthAssessment	WellnessApplicationPublicApi_Entities_V1_PhaNotifications_PersonalHealthAssessmentReference	true	The reference to the PHA.	-
domain	string	true	The domain with which the PHA email notification is associated.	-
phaResponseBeginsAfter	string	true	The date on or after which a consumer started the PHA response in ISO 8601 YYYY-MM-DD format. This value is used to filter the consumers to send a notification when the request is processed. This date is relevant only for filtering the consumers who have completed their PHA.	-
phaResponseEndsBefore	string	true	The date on or before which a consumer completed the PHA response in ISO 8601 YYYY-MM-DD format. This value is used to filter the consumers to send a notification when the request is processed. This date is relevant only for filtering the consumers who have completed their PHA.	-
phaResponseStatus	string	true	The status of the PHA response. The status is used to filter the list of consumers who are eligible to receive the email notification. The supported statuses include `NOT_STARTED`, `IN_PROGRESS`, and `COMPLETED`.	NOT_STARTED, IN_PROGRESS, COMPLETED
locale	string	true	The locale for which this PHA email notification is configured.	-
emailSubject	string	true	The subject of the email for the PHA notification.	-
emailBody	string	true	The body of the email for the PHA notification. The body is sent in HTML format.	-
sendNotificationOn	string(date)	true	The date on which the PHA email notifications should be sent in ISO 8601 YYYY-MM-DD format. If this value is not provided, the notification is sent within the next 24 hours.	-
notificationStatus	string	true	The current status of a particular PHA email notification. The default status value is `NOT_SENT`. The supported status values include `NOT_SENT`, `SENDING`, and `SENT`.	-
qualifiedConsumersCount	integer(int32)	true	The total number of consumers who satisfy the criteria based on the `phaResponseBeginsAfter`, `phaResponseEndsBefore`, and `phaResponseStatus` values. It is possible that not all qualified members will receive an email. The total number of qualified members may not be available immediately after creating the notification request. In such cases, a nil value is returned.	-
createdAt	string(date-time)	true	The date and time when the PHA email notification request was created. In ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-
updatedAt	string(date-time)	true	The date and time when the PHA email notification was last updated. In ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-
notificationProcessedAt	string(date-time)	true	The date and time when the notification was processed. This is the date and time when the notification was successfully processed for all qualifying consumers in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-

WellnessApplicationPublicApi_Entities_V1_PhaNotifications_PersonalHealthAssessmentReference

Name	Type	Required	Description	Accepted Values
phaId	string	true	The ID of the PHA.	-

putPhaEmailNotifications

Name	Type	Required	Description	Accepted Values
domain	string	true	The domain with which the PHA email notification is associated.	-
phaResponseBeginsAfter	string	false	The date on or after which a consumer started the PHA response in ISO 8601 YYYY-MM-DD format. This value is used to filter the consumers for sending a notification when the request is processed. This date is relevant only for filtering the consumers who completed their PHA.	-
phaResponseEndsBefore	string	false	The date on or before which a consumer completed the PHA response in ISO 8601 YYYY-MM-DD format. This value is used to filter the consumers for sending a notification when the request is processed. This date is relevant only for filtering the consumers who completed their PHA.	-
phaResponseStatus	string	true	The status of the PHA response. The status is used to filter the list of consumers who are eligible to receive the email notification. The supported statuses include `NOT_STARTED`, `IN_PROGRESS`, and `COMPLETED`.	-
locale	string	true	The locale for which the PHA email notification is configured.	-
emailSubject	string	true	The subject of the email for PHA notification.	-
emailBody	string	true	The body of the email for PHA notification. The body is sent in HTML format.	-
sendNotificationOn	string	true	The date on which the PHA email notifications should be sent in ISO 8601 YYYY-MM-DD format. The date must be in the future.	-

postEmailNotifications

Name	Type	Required	Description	Accepted Values
domain	string	true	The domain associated with an email notification.	-
locale	string	true	The locale for which an email notification is configured.	-
emailSubject	string	true	The subject of an email notification.	-
emailBody	string	true	The body of an email notification. The body is sent in HTML format.	-
sendNotificationOn	string	true	The date on which an email notification should be sent in ISO 8601 YYYY-MM-DD format. The date must be in the future.	-

WellnessApplicationPublicApi_Entities_V1_EmailNotifications_EmailNotification

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of an email notification.	-
domain	string	true	The domain associated with an email notification.	-
locale	string	true	The locale for which an email notification is configured.	-
emailSubject	string	true	The subject of an email notification.	-
emailBody	string	true	The body of an email notification. The body is sent in HTML format.	-
sendNotificationOn	string(date)	false	The date on which an email notification should be sent in ISO 8601 YYYY-MM-DD format. If it is not provided, the notification is sent within the next 24 hours.	-
notificationStatus	string	false	The current status of an email notification. The default status value is `NOT_SENT`. The supported status values include `NOT_SENT`, `SENDING`, and `SENT`.	-
qualifiedConsumersCount	integer(int32)	true	The total number of consumers who are qualified to receive the email. It is possible that not all qualified members will receive an email. The total number of qualified members may not be available immediately after the notification request is created. In such cases, a nil value is returned.	-
createdAt	string(date-time)	true	The date and time when an email notification request was created in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-
updatedAt	string(date-time)	true	The date and time when an email notification was last updated in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-
notificationProcessedAt	string(date-time)	true	The date and time when an email notification was processed. This value is the date and time when the notification was successfully processed for all consumers in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-

EmailNotifications

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

putEmailNotifications

Name	Type	Required	Description	Accepted Values
domain	string	true	The domain associated with an email notification.	-
locale	string	true	The locale for which an email notification is configured.	-
emailSubject	string	true	The subject of an email notification.	-
emailBody	string	true	The body of an email notification. The body is sent in HTML format.	-
sendNotificationOn	string	true	The date on which an email notification should be sent in ISO 8601 YYYY-MM-DD format. The date must be in the future.	-

postEnrollWellnessUsers

Name	Type	Required	Description	Accepted Values
consumer	object	true	A reference to the consumer documented in the eligibility record.	-
» id	string	true	The ID of the consumer.	-
member	object	true	A reference to the member documented in the eligibility record.	-
» id	string	true	The ID of the member.	-
» group	string	true	The member group of an eligible member. This information is used to attach an alias to a consumer group in the Consumer Well-being system.	-
relationship	string	false	The relationship of an eligible member to a tenant. The following values are possible: `PLAN_MEMBER`: Indicates the primary plan member. `PLAN_MEMBER_SPOUSE`: Indicates the spouse of the plan member. `EMPLOYEE`: Indicates an employee of the organization. `EMPLOYEE_SPOUSE`: Indicates the spouse of an employee.	PLAN_MEMBER, PLAN_MEMBER_SPOUSE, EMPLOYEE, EMPLOYEE_SPOUSE
terminationDate	string	false	The termination date of an eligible member. This date indicates when an eligible member is disabled from using the Consumer Well-being system and is in ISO 8601 YYYY-MM-DD format	-
additionalInformation	[object]	false	The additional information section enables attaching metadata that is related to but does not supply any semantic meaning to the eligibility record. A maximum of 10 name and value pairs can be specified for the metadata of an eligibility record.	-
» name	string	true	The name of the field that describes the metadata of the eligibility record. The maximum length is 191 characters.	-
» value	string	true	The value of the eligbility record’s metadata. The maximum length is 191 characters.	-
domain	string	false	The domain with which the eligible user is associated, for the purpose of assigning them to a campaign.	-
updatedBy	object	false	The type and ID of the source from which the eligibility record was created or modified.	-
» type	string	true	Who or what created or updated the elegibility record. The only accepted value is `ADMIN`, which indicates an administrator.	ADMIN
» id	string	true	An ID for a system or person, such as an administrator, that creates or updates the eligibility record.	-

WellnessApplicationPublicApi_Entities_V1_EnrollWellnessUsers_EligibleUser

Name	Type	Required	Description	Accepted Values
eligibilityRecordId	string	true	The ID of the eligibility record.	-
consumer	WellnessApplicationPublicApi_Entities_V1_EnrollWellnessUsers_ConsumerReference	true	A reference to the consumer documented in the eligibility record.	-
member	WellnessApplicationPublicApi_Entities_V1_EnrollWellnessUsers_MemberReference	true	A reference to the member documented in the eligibility record.	-
domain	string	false	The domain with which the eligible user is associated, for the purpose of assigning them to a campaign.	-
relationship	string	false	The relationship of an eligible member to a tenant. The following values are possible: `PLAN_MEMBER`: Indicates the primary plan member. `PLAN_MEMBER_SPOUSE`: Indicates the spouse of the plan member. `EMPLOYEE`: Indicates an employee of the organization. `EMPLOYEE_SPOUSE`: Indicates the spouse of an employee.	PLAN_MEMBER, PLAN_MEMBER_SPOUSE, EMPLOYEE, EMPLOYEE_SPOUSE
terminationDate	string	false	The termination date of an eligible member. This date indicates when an eligible member is disabled from using the Consumer Well-being system and is in ISO 8601 YYYY-MM-DD format	-
additionalInformation	[WellnessApplicationPublicApi_Entities_V1_EnrollWellnessUsers_AdditionalInformation]	false	The additional information section enables attaching metadata that is related to but does not supply any semantic meaning to the eligibility record. A maximum of 10 name and value pairs can be specified for the metadata of an eligibility record.	-
updatedBy	WellnessApplicationPublicApi_Entities_V1_EnrollWellnessUsers_UpdatedBy	false	The type and ID of the source from which the eligibility record was created or modified.	-

WellnessApplicationPublicApi_Entities_V1_EnrollWellnessUsers_ConsumerReference

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

WellnessApplicationPublicApi_Entities_V1_EnrollWellnessUsers_MemberReference

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the member.	-
group	string	true	The member group of an eligible member. This information is used to attach an alias to a consumer group in the Consumer Well-being system.	-

WellnessApplicationPublicApi_Entities_V1_EnrollWellnessUsers_AdditionalInformation

Name	Type	Required	Description	Accepted Values
name	string	true	The name of the field that describes the metadata of the eligibility record. The maximum length is 191 characters.	-
value	string	true	The value of the eligbility record’s metadata. The maximum length is 191 characters.	-

WellnessApplicationPublicApi_Entities_V1_EnrollWellnessUsers_UpdatedBy

Name	Type	Required	Description	Accepted Values
type	string	true	Who or what created or updated the elegibility record. The only accepted value is `ADMIN`, which indicates an administrator.	ADMIN
id	string	true	An ID for a system or person, such as an administrator, that creates or updates the eligibility record.	-

putEnrollWellnessUsers

Name	Type	Required	Description	Accepted Values
consumer	object	true	A reference to the consumer documented in the eligibility record.	-
» id	string	true	The ID of the consumer.	-
member	object	true	A reference to the member documented in the eligibility record.	-
» id	string	true	The ID of the member.	-
» group	string	true	The member group of an eligible member. This information is used to attach an alias to a consumer group in the Consumer Well-being system.	-
relationship	string	false	The relationship of an eligible member to a tenant. The following values are possible: `PLAN_MEMBER`: Indicates the primary plan member. `PLAN_MEMBER_SPOUSE`: Indicates the spouse of the plan member. `EMPLOYEE`: Indicates an employee of the organization. `EMPLOYEE_SPOUSE`: Indicates the spouse of an employee.	PLAN_MEMBER, PLAN_MEMBER_SPOUSE, EMPLOYEE, EMPLOYEE_SPOUSE
terminationDate	string	false	The termination date of an eligible member. This date indicates when an eligible member is disabled from using the Consumer Well-being system and is in ISO 8601 YYYY-MM-DD format	-
additionalInformation	[object]	false	The additional information section enables attaching metadata that is related to but does not supply any semantic meaning to the eligibility record. A maximum of 10 name and value pairs can be specified for the metadata of an eligibility record.	-
» name	string	true	The name of the field that describes the metadata of the eligibility record. The maximum length is 191 characters.	-
» value	string	true	The value of the eligbility record’s metadata. The maximum length is 191 characters.	-
domain	string	false	The domain with which the eligible user is associated, for the purpose of assigning them to a campaign.	-
updatedBy	object	false	The type and ID of the source from which the eligibility record was created or modified.	-
» type	string	true	Who or what created or updated the elegibility record. The only accepted value is `ADMIN`, which indicates an administrator.	ADMIN
» id	string	true	An ID for a system or person, such as an administrator, that creates or updates the eligibility record.	-

postVendorRewardConfigs

Name	Type	Required	Description	Accepted Values
domain	string	true	The domain associated with the vendor reward configuration.	-
vendorConfigId	string	true	The ID of the vendor configuration that you want to associate with the domain.	-

WellnessApplicationPublicApi_Entities_V1_Reward_VendorRewardConfig

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the vendor reward configuration.	-
vendorConfigId	string	true	The ID of the vendor configuration that you want to associate with the domain.	-
domain	string	true	The domain associated with the vendor reward configuration.	-
createdAt	string	true	The date and time at which the vendor reward configuration was created, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-
updatedAt	string	true	The date and time at which the vendor reward configuration was last updated, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-

VendorRewardConfigs

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

putVendorRewardConfigs

Name	Type	Required	Description	Accepted Values
domain	string	true	The domain associated with the vendor reward configuration.	-
vendorConfigId	string	true	The ID of the vendor configuration that you want to associate with the domain.	-