Consumer Engagement API v1

The Consumer Engagement service provides a way to directly interact with your consumers to encourage them to be involved and invested in their health journeys. This service allows you to inform and update consumers, coordinate events and challenges, and provide interactive educational content.

URL: https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1

Event

An event is an activity that is intended to support the discovery and development of healthy habits. The event resources can be used to create and manage single session and multisession events to engage consumers. In addition, they can be used to send outreach emails to consumers registered for an event on a specific date in future.

Create an Event Location




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/consumer-engagement/v1/event-locations', headers: headers, body: {"name":"Innovations Healthe Clinic","names":[{"locale":"en-US","value":"Localized value."}],"description":"Clinic located in the North tower lobby of the Cerner Innovations Campus.","descriptions":[{"locale":"en-US","value":"Localized value."}],"address":{"lines":["8779 Hillcrest Road","Innovations Campus"],"city":"Kansas City","district":"Jackson County","state":"MO","country":"US","postalCode":"64138"},"restrictedToCatalogs":[{"id":"cef0be9e-9bec-4f5e-8004-0252cab4b991"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/event-locations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Innovations Healthe Clinic","names":[{"locale":"en-US","value":"Localized value."}],"description":"Clinic located in the North tower lobby of the Cerner Innovations Campus.","descriptions":[{"locale":"en-US","value":"Localized value."}],"address":{"lines":["8779 Hillcrest Road","Innovations Campus"],"city":"Kansas City","district":"Jackson County","state":"MO","country":"US","postalCode":"64138"},"restrictedToCatalogs":[{"id":"cef0be9e-9bec-4f5e-8004-0252cab4b991"}]}

POST /event-locations

Creates a new event location where an event can be held. The event location represents a physical or virtual address.

Parameters

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

Response Statuses

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

Retrieve a List of Event Locations


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/consumer-engagement/v1/event-locations', headers: headers)

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "cea6f1d9-f986-4695-be33-0c2034579323",
      "name": "Innovations Healthe Clinic",
      "description": "Clinic located in the North tower lobby of the Cerner Innovations Campus.",
      "names": [
        {
          "locale": "en-US",
          "value": "Localized value."
        }
      ],
      "descriptions": [
        {
          "locale": "en-US",
          "value": "Localized value."
        }
      ],
      "address": {
        "lines": [
          "8779 Hillcrest Road",
          "Innovations Campus"
        ],
        "city": "Kansas City",
        "district": "Jackson County",
        "state": "MO",
        "country": "US",
        "postalCode": "64138"
      },
      "restrictedToCatalogs": [
        {
          "id": "cef0be9e-9bec-4f5e-8004-0252cab4b991"
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/event-locations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/event-locations?offset=0&limit=20"
}

GET /event-locations

Retrieves all of the event locations where an event can be held.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
availableForCatalog	query	array[string]	false	N/A	Filters by those locations available for the specified catalog.	-
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.	Locations
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Update an Event Location




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/consumer-engagement/v1/event-locations/cea6f1d9-f986-4695-be33-0c2034579323', headers: headers, body: {"name":"Innovations Healthe Clinic","names":[{"locale":"en-US","value":"Localized value."}],"description":"Clinic located in the North tower lobby of the Cerner Innovations Campus.","descriptions":[{"locale":"en-US","value":"Localized value."}],"address":{"lines":["8779 Hillcrest Road","Innovations Campus"],"city":"Kansas City","district":"Jackson County","state":"MO","country":"US","postalCode":"64138"},"restrictedToCatalogs":[{"id":"cef0be9e-9bec-4f5e-8004-0252cab4b991"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/event-locations/cea6f1d9-f986-4695-be33-0c2034579323 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Innovations Healthe Clinic","names":[{"locale":"en-US","value":"Localized value."}],"description":"Clinic located in the North tower lobby of the Cerner Innovations Campus.","descriptions":[{"locale":"en-US","value":"Localized value."}],"address":{"lines":["8779 Hillcrest Road","Innovations Campus"],"city":"Kansas City","district":"Jackson County","state":"MO","country":"US","postalCode":"64138"},"restrictedToCatalogs":[{"id":"cef0be9e-9bec-4f5e-8004-0252cab4b991"}]}

PUT /event-locations/{locationId}

Updates the information for an event location.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
locationId	path	string	true	N/A	The ID of the location.	-
body	body	putEventLocations	true	N/A	No description	-

Response Statuses

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

Retrieve a Single Event Location


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/consumer-engagement/v1/event-locations/cea6f1d9-f986-4695-be33-0c2034579323', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/event-locations/cea6f1d9-f986-4695-be33-0c2034579323 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

GET /event-locations/{locationId}

Retrieves an event location by its ID. Used to retrieve information for a single event location.

Parameters

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

Response Statuses

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

Create an Event Category




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/consumer-engagement/v1/event-categories', headers: headers, body: {"name":"Preventive Health","names":[{"locale":"en-US","value":"Localized value."}],"code":{"code":"310422005","display":"Prevention/screening","system":"2.16.840.1.113883.6.96"},"restrictedToCatalogs":[{"id":"cef0be9e-9bec-4f5e-8004-0252cab4b991"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/event-categories \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Preventive Health","names":[{"locale":"en-US","value":"Localized value."}],"code":{"code":"310422005","display":"Prevention/screening","system":"2.16.840.1.113883.6.96"},"restrictedToCatalogs":[{"id":"cef0be9e-9bec-4f5e-8004-0252cab4b991"}]}

POST /event-categories

Creates a new event category that classifies events. The event category groups events based on the event’s classification.

Parameters

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

Response Statuses

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

Retrieve a List of Event Categories


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/consumer-engagement/v1/event-categories', headers: headers)

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "da4cac69-462d-4e3e-8870-a39fad628354",
      "name": "Preventive Health",
      "names": [
        {
          "locale": "en-US",
          "value": "Localized value."
        }
      ],
      "code": {
        "code": "310422005",
        "display": "Prevention/screening",
        "system": "2.16.840.1.113883.6.96"
      },
      "restrictedToCatalogs": [
        {
          "id": "cef0be9e-9bec-4f5e-8004-0252cab4b991"
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/event-categories?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/event-categories?offset=0&limit=20"
}

GET /event-categories

Retrieves all of the event categories that can classify an event.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
availableForCatalog	query	array[string]	false	N/A	Filters by those categories available for the specified catalog.	-
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.	Categories
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Update an Event Category




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/consumer-engagement/v1/event-categories/da4cac69-462d-4e3e-8870-a39fad628354', headers: headers, body: {"name":"Preventive Health","names":[{"locale":"en-US","value":"Localized value."}],"code":{"code":"310422005","display":"Prevention/screening","system":"2.16.840.1.113883.6.96"},"restrictedToCatalogs":[{"id":"cef0be9e-9bec-4f5e-8004-0252cab4b991"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/event-categories/da4cac69-462d-4e3e-8870-a39fad628354 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Preventive Health","names":[{"locale":"en-US","value":"Localized value."}],"code":{"code":"310422005","display":"Prevention/screening","system":"2.16.840.1.113883.6.96"},"restrictedToCatalogs":[{"id":"cef0be9e-9bec-4f5e-8004-0252cab4b991"}]}

PUT /event-categories/{categoryId}

Updates the information for an event category.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
categoryId	path	string	true	N/A	The ID of the category.	-
body	body	putEventCategories	true	N/A	No description	-

Response Statuses

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

Retrieve a Single Event Category


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/consumer-engagement/v1/event-categories/da4cac69-462d-4e3e-8870-a39fad628354', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/event-categories/da4cac69-462d-4e3e-8870-a39fad628354 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

GET /event-categories/{categoryId}

Retrieves an event category by its ID. Used to retrieve information for a single event category.

Parameters

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

Response Statuses

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

Create an Event Catalog




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/consumer-engagement/v1/event-catalogs', headers: headers, body: {"name":"2019 Incentivized Events Catalog","description":"Catalog to group incentivized events in 2019."}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/event-catalogs \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"2019 Incentivized Events Catalog","description":"Catalog to group incentivized events in 2019."}

POST /event-catalogs

Creates a new event catalog that can group events and event series. Events and event series can be included in event catalogs to group the events and event series. To remove an event or event series from an event catalog, the event or event series must be updated to remove the event catalog reference.

Parameters

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

Response Statuses

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

Retrieve a List of Event Catalogs


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/consumer-engagement/v1/event-catalogs', headers: headers)

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "cef0be9e-9bec-4f5e-8004-0252cab4b991",
      "name": "2019 Incentivized Events Catalog",
      "description": "Catalog to group incentivized events in 2019."
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/event-catalogs?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/event-catalogs?offset=0&limit=20"
}

GET /event-catalogs

Retrieves all of the event catalogs that can group events and event series.

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

Update an Event Catalog




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/consumer-engagement/v1/event-catalogs/cef0be9e-9bec-4f5e-8004-0252cab4b991', headers: headers, body: {"name":"2019 Incentivized Events Catalog","description":"Catalog to group incentivized events in 2019."}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/event-catalogs/cef0be9e-9bec-4f5e-8004-0252cab4b991 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"2019 Incentivized Events Catalog","description":"Catalog to group incentivized events in 2019."}

PUT /event-catalogs/{catalogId}

Updates the information for an event catalog.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
catalogId	path	string	true	N/A	The ID of the catalog.	-
body	body	putEventCatalogs	true	N/A	No description	-

Response Statuses

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

Retrieve an Event Catalog


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/consumer-engagement/v1/event-catalogs/cef0be9e-9bec-4f5e-8004-0252cab4b991', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/event-catalogs/cef0be9e-9bec-4f5e-8004-0252cab4b991 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

GET /event-catalogs/{catalogId}

Retrieves an event catalog by its ID. Used to retrieve information for a single event catalog.

Parameters

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

Response Statuses

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

Create an Event




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/consumer-engagement/v1/events', headers: headers, body: {"name":"Stress Management Seminar 2019","description":"This seminar is designed to contribute to the mental health development of individuals. Attendees will learn techniques to manage and cope with stressful situations.","names":[{"locale":"en-US","value":"Localized value."}],"descriptions":[{"locale":"en-US","value":"Localized value."}],"leader":{"name":"Dr. Jane Elizabeth Smith","telecoms":[{"system":"EMAIL","value":"jane.smith@rockhurst.edu"}]},"registrationStatus":"OPEN","startsAt":"2019-01-15T08:00:00","endsAt":"2019-10-15T16:00:00","timeZone":"America/New_York","multislot":true,"status":"ACTIVE","location":{"id":"cea6f1d9-f986-4695-be33-0c2034579323"},"category":{"id":"da4cac69-462d-4e3e-8870-a39fad628354"},"catalogs":[{"id":"cef0be9e-9bec-4f5e-8004-0252cab4b991"}],"series":{"id":"11a3bbec-5378-47ac-89bb-b03b5dcec1cf"},"scopes":[{"id":"gtf0tg5e-7hnt-44re-6623-2789htb4b465"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/events \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Stress Management Seminar 2019","description":"This seminar is designed to contribute to the mental health development of individuals. Attendees will learn techniques to manage and cope with stressful situations.","names":[{"locale":"en-US","value":"Localized value."}],"descriptions":[{"locale":"en-US","value":"Localized value."}],"leader":{"name":"Dr. Jane Elizabeth Smith","telecoms":[{"system":"EMAIL","value":"jane.smith@rockhurst.edu"}]},"registrationStatus":"OPEN","startsAt":"2019-01-15T08:00:00","endsAt":"2019-10-15T16:00:00","timeZone":"America/New_York","multislot":true,"status":"ACTIVE","location":{"id":"cea6f1d9-f986-4695-be33-0c2034579323"},"category":{"id":"da4cac69-462d-4e3e-8870-a39fad628354"},"catalogs":[{"id":"cef0be9e-9bec-4f5e-8004-0252cab4b991"}],"series":{"id":"11a3bbec-5378-47ac-89bb-b03b5dcec1cf"},"scopes":[{"id":"gtf0tg5e-7hnt-44re-6623-2789htb4b465"}]}

POST /events

Creates a new event, which allows consumers to view information about the event. For a consumer to register for the event, an event slot must be created.

Parameters

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

Response Statuses

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

Retrieve a List of Events


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/consumer-engagement/v1/events', headers: headers)

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "bf6357e2-57ea-4c8e-b79d-2c4f817fa4f8",
      "name": "Stress Management Seminar 2019",
      "description": "This seminar is designed to contribute to the mental health development of individuals. Attendees will learn techniques to manage and cope with stressful situations.",
      "names": [
        {
          "locale": "en-US",
          "value": "Localized value."
        }
      ],
      "descriptions": [
        {
          "locale": "en-US",
          "value": "Localized value."
        }
      ],
      "leader": {
        "name": "Dr. Jane Elizabeth Smith",
        "telecoms": [
          {
            "system": "EMAIL",
            "value": "jane.smith@rockhurst.edu"
          }
        ]
      },
      "registrationStatus": "OPEN",
      "startsAt": "2019-01-15T08:00:00",
      "endsAt": "2019-10-15T16:00:00",
      "timeZone": "America/New_York",
      "multislot": true,
      "location": {
        "id": "cea6f1d9-f986-4695-be33-0c2034579323",
        "name": "Innovations Healthe Clinic",
        "description": "Clinic located in the North tower lobby of the Cerner Innovations Campus.",
        "names": [
          {
            "locale": "en-US",
            "value": "Localized value."
          }
        ],
        "descriptions": [
          {
            "locale": "en-US",
            "value": "Localized value."
          }
        ],
        "address": {
          "lines": [
            "8779 Hillcrest Road",
            "Innovations Campus"
          ],
          "city": "Kansas City",
          "district": "Jackson County",
          "state": "MO",
          "country": "US",
          "postalCode": "64138"
        },
        "restrictedToCatalogs": [
          {
            "id": "cef0be9e-9bec-4f5e-8004-0252cab4b991"
          }
        ]
      },
      "category": {
        "id": "da4cac69-462d-4e3e-8870-a39fad628354",
        "name": "Preventive Health",
        "names": [
          {
            "locale": "en-US",
            "value": "Localized value."
          }
        ],
        "code": {
          "code": "310422005",
          "display": "Prevention/screening",
          "system": "2.16.840.1.113883.6.96"
        },
        "restrictedToCatalogs": [
          {
            "id": "cef0be9e-9bec-4f5e-8004-0252cab4b991"
          }
        ]
      },
      "catalogs": [
        {
          "id": "cef0be9e-9bec-4f5e-8004-0252cab4b991"
        }
      ],
      "series": {
        "id": "11a3bbec-5378-47ac-89bb-b03b5dcec1cf"
      },
      "scopes": [
        {
          "id": "gtf0tg5e-7hnt-44re-6623-2789htb4b465"
        }
      ],
      "status": "ACTIVE"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/events?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/events?offset=0&limit=20"
}

GET /events

Retrieves all of the events that meet the specified parameters. Used to display available events to consumers. The retrieved events include the location and category information.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
from	query	string	false	N/A	Filters the retrieved events to only those with at least one slot whose start time is on or after the specified date and time. The value must be in ISO 8601 YYYY-MM-DDThh:mm:ssZ format.	-
to	query	string	false	N/A	Filters the retrieved events to only those with at least one slot whose end time is on or before the specified date and time. The value must be in ISO 8601 YYYY-MM-DDThh:mm:ssZ format.	-
categoryId	query	string	false	N/A	Filters by the ID of the category.	-
locationId	query	string	false	N/A	Filters by the ID of the location.	-
registrationStatus	query	string	false	N/A	Filters by the registration status of the event. If the registration status is OPEN, only events that take place in the future are returned.	-
catalogId	query	array[string]	false	N/A	Filters by the ID of the catalog.	-
scopeId	query	array[string]	false	N/A	Filters by the ID of the scope.	-
seriesId	query	array[string]	false	N/A	Filters by the ID or IDs of one or many series.	-
partOfSeries	query	boolean	false	N/A	Filters the retrieved events to only those that are part of a series.	-
status	query	string	false	N/A	Filters by the status of the event.	-
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.	Events
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Update an Event




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/consumer-engagement/v1/events/bf6357e2-57ea-4c8e-b79d-2c4f817fa4f8', headers: headers, body: {"name":"Stress Management Seminar 2019","description":"This seminar is designed to contribute to the mental health development of individuals. Attendees will learn techniques to manage and cope with stressful situations.","names":[{"locale":"en-US","value":"Localized value."}],"descriptions":[{"locale":"en-US","value":"Localized value."}],"leader":{"name":"Dr. Jane Elizabeth Smith","telecoms":[{"system":"EMAIL","value":"jane.smith@rockhurst.edu"}]},"registrationStatus":"OPEN","startsAt":"2019-01-15T08:00:00","endsAt":"2019-10-15T16:00:00","timeZone":"America/New_York","multislot":true,"status":"ACTIVE","location":{"id":"cea6f1d9-f986-4695-be33-0c2034579323"},"category":{"id":"da4cac69-462d-4e3e-8870-a39fad628354"},"catalogs":[{"id":"cef0be9e-9bec-4f5e-8004-0252cab4b991"}],"series":{"id":"11a3bbec-5378-47ac-89bb-b03b5dcec1cf"},"scopes":[{"id":"gtf0tg5e-7hnt-44re-6623-2789htb4b465"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/events/bf6357e2-57ea-4c8e-b79d-2c4f817fa4f8 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Stress Management Seminar 2019","description":"This seminar is designed to contribute to the mental health development of individuals. Attendees will learn techniques to manage and cope with stressful situations.","names":[{"locale":"en-US","value":"Localized value."}],"descriptions":[{"locale":"en-US","value":"Localized value."}],"leader":{"name":"Dr. Jane Elizabeth Smith","telecoms":[{"system":"EMAIL","value":"jane.smith@rockhurst.edu"}]},"registrationStatus":"OPEN","startsAt":"2019-01-15T08:00:00","endsAt":"2019-10-15T16:00:00","timeZone":"America/New_York","multislot":true,"status":"ACTIVE","location":{"id":"cea6f1d9-f986-4695-be33-0c2034579323"},"category":{"id":"da4cac69-462d-4e3e-8870-a39fad628354"},"catalogs":[{"id":"cef0be9e-9bec-4f5e-8004-0252cab4b991"}],"series":{"id":"11a3bbec-5378-47ac-89bb-b03b5dcec1cf"},"scopes":[{"id":"gtf0tg5e-7hnt-44re-6623-2789htb4b465"}]}

PUT /events/{eventId}

Updates information for an event as well as any series, catalog, location, and category associations. Any slots associated with the event are not affected by this update.

Parameters

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

Response Statuses

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

Delete an Event


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/consumer-engagement/v1/events/bf6357e2-57ea-4c8e-b79d-2c4f817fa4f8', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/events/bf6357e2-57ea-4c8e-b79d-2c4f817fa4f8 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /events/{eventId}

Deletes an event. This request is intended for events that are created in error. Events with registrations cannot be deleted. If an event has registrations, the event should be updated to set the status field to CANCELLED.

Parameters

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

Response Statuses

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

Retrieve a Single Event


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/consumer-engagement/v1/events/bf6357e2-57ea-4c8e-b79d-2c4f817fa4f8', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/events/bf6357e2-57ea-4c8e-b79d-2c4f817fa4f8 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

GET /events/{eventId}

Retrieves a single event by its ID. Can be used to get information for a single event. This request retrieves only information about the Event resource. Location and category information is not included.

Parameters

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

Response Statuses

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

Create an Event Slot




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/consumer-engagement/v1/events/bf6357e2-57ea-4c8e-b79d-2c4f817fa4f8/slots', headers: headers, body: {"description":"The session will begin at 8:00 a.m. and is expected to end by 4:00 p.m. Light breakfast and lunch will be provided. Please let us know if you have any dietary restrictions.","descriptions":[{"locale":"en-US","value":"Localized value."}],"maxRegistrations":100,"startsAt":"2019-09-15T08:00:00","endsAt":"2019-09-15T16:00:00","registrationEndsAt":"2019-09-14T08:00:00","timeZone":"America/New_York","status":"ACTIVE"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/events/bf6357e2-57ea-4c8e-b79d-2c4f817fa4f8/slots \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"description":"The session will begin at 8:00 a.m. and is expected to end by 4:00 p.m. Light breakfast and lunch will be provided. Please let us know if you have any dietary restrictions.","descriptions":[{"locale":"en-US","value":"Localized value."}],"maxRegistrations":100,"startsAt":"2019-09-15T08:00:00","endsAt":"2019-09-15T16:00:00","registrationEndsAt":"2019-09-14T08:00:00","timeZone":"America/New_York","status":"ACTIVE"}

POST /events/{eventId}/slots

Creates a new event slot for an event. An event slot provides the period of time when the event is hosted as well as registration information.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
201	Created	Created.	ConsumerEngagementPublicApi_Entities_V1_Events_Slot
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Retrieve a List of Event Slots


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/consumer-engagement/v1/events/bf6357e2-57ea-4c8e-b79d-2c4f817fa4f8/slots', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/events/bf6357e2-57ea-4c8e-b79d-2c4f817fa4f8/slots \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "337c98f3-b1aa-4ab2-9c9c-1a973457cfe7",
      "description": "The session will begin at 8:00 a.m. and is expected to end by 4:00 p.m. Light breakfast and lunch will be provided. Please let us know if you have any dietary restrictions.",
      "descriptions": [
        {
          "locale": "en-US",
          "value": "Localized value."
        }
      ],
      "maxRegistrations": 100,
      "availableRegistrations": 100,
      "startsAt": "2019-09-15T08:00:00",
      "endsAt": "2019-09-15T16:00:00",
      "registrationEndsAt": "2019-09-14T08:00:00",
      "timeZone": "America/New_York",
      "status": "ACTIVE"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/events/bf6357e2-57ea-4c8e-b79d-2c4f817fa4f8/slots?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/events/bf6357e2-57ea-4c8e-b79d-2c4f817fa4f8/slots?offset=0&limit=20"
}

GET /events/{eventId}/slots

Retrieves all of the event slots for the specified event ID. Can be used to display the event slots to a consumer.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
eventId	path	string	true	N/A	The ID of the event.	-
status	query	string	false	N/A	Filters by the status of the slot.	-
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.	Slots
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Update an Event Slot




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/consumer-engagement/v1/events/bf6357e2-57ea-4c8e-b79d-2c4f817fa4f8/slots/337c98f3-b1aa-4ab2-9c9c-1a973457cfe7', headers: headers, body: {"description":"The session will begin at 8:00 a.m. and is expected to end by 4:00 p.m. Light breakfast and lunch will be provided. Please let us know if you have any dietary restrictions.","descriptions":[{"locale":"en-US","value":"Localized value."}],"maxRegistrations":100,"startsAt":"2019-09-15T08:00:00","endsAt":"2019-09-15T16:00:00","registrationEndsAt":"2019-09-14T08:00:00","timeZone":"America/New_York","status":"ACTIVE"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/events/bf6357e2-57ea-4c8e-b79d-2c4f817fa4f8/slots/337c98f3-b1aa-4ab2-9c9c-1a973457cfe7 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"description":"The session will begin at 8:00 a.m. and is expected to end by 4:00 p.m. Light breakfast and lunch will be provided. Please let us know if you have any dietary restrictions.","descriptions":[{"locale":"en-US","value":"Localized value."}],"maxRegistrations":100,"startsAt":"2019-09-15T08:00:00","endsAt":"2019-09-15T16:00:00","registrationEndsAt":"2019-09-14T08:00:00","timeZone":"America/New_York","status":"ACTIVE"}

PUT /events/{eventId}/slots/{slotId}

Updates the information for an event slot. The event that the event slot belongs to is not affected by this update.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
eventId	path	string	true	N/A	The ID of the event.	-
slotId	path	string	true	N/A	The ID of the event slot.	-
body	body	putEventsEventidSlots	true	N/A	No description	-

Response Statuses

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

Delete an Event Slot


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/consumer-engagement/v1/events/bf6357e2-57ea-4c8e-b79d-2c4f817fa4f8/slots/337c98f3-b1aa-4ab2-9c9c-1a973457cfe7', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/events/bf6357e2-57ea-4c8e-b79d-2c4f817fa4f8/slots/337c98f3-b1aa-4ab2-9c9c-1a973457cfe7 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /events/{eventId}/slots/{slotId}

Deletes an event slot. This request is intended for event slots that are created in error. Event slots with registrations cannot be deleted. If an event slot has registrations, the event slot should be updated to set the status field to CANCELLED.

Parameters

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

Response Statuses

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

Retrieve a Single Event Slot


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/consumer-engagement/v1/events/bf6357e2-57ea-4c8e-b79d-2c4f817fa4f8/slots/337c98f3-b1aa-4ab2-9c9c-1a973457cfe7', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/events/bf6357e2-57ea-4c8e-b79d-2c4f817fa4f8/slots/337c98f3-b1aa-4ab2-9c9c-1a973457cfe7 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

GET /events/{eventId}/slots/{slotId}

Retrieves a single event slot by its event and slot IDs. Can be used to retrieve information for a single event slot.

Parameters

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

Response Statuses

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

Create Multiple Slots for an Event




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/consumer-engagement/v1/event-slots', headers: headers, body: {"slots":[{"event":{"id":"35eb9e2d-0bb4-4e30-8245-fd07525da9fe"},"descriptions":[{"locale":"en-US","value":"Localized value."}],"maxRegistrations":100,"availableRegistrations":100,"startsAt":"2019-09-15T08:00:00","endsAt":"2019-09-15T16:00:00","registrationEndsAt":"2019-09-14T08:00:00","timeZone":"America/New_York","status":"ACTIVE"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/event-slots \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"slots":[{"event":{"id":"35eb9e2d-0bb4-4e30-8245-fd07525da9fe"},"descriptions":[{"locale":"en-US","value":"Localized value."}],"maxRegistrations":100,"availableRegistrations":100,"startsAt":"2019-09-15T08:00:00","endsAt":"2019-09-15T16:00:00","registrationEndsAt":"2019-09-14T08:00:00","timeZone":"America/New_York","status":"ACTIVE"}]}

POST /event-slots

Creates multiple slots for a single event. Each event slot shows the time when the event is hosted as well as registration information. The event is specified by its ID within the Post body, and the event ID for all slots should be the same. The ordering of the response will be the same as the ordering of the request. The request can contain as many slots necessary for a singular event. If one of the slots is invalid, no slots will be created.

Parameters

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

Response Statuses

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

Create an Event Series




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/consumer-engagement/v1/event-series', headers: headers, body: {"name":"Screenings 2019","description":"Screening 2019 is a two-session event that involves body measurements and the collection of a small blood sample. The biometric screening results help provide detailed assessments of a person's health and improve health outcomes.","names":[{"locale":"en-US","value":"Localized value."}],"descriptions":[{"locale":"en-US","value":"Localized value."}],"leader":{"name":"Dr. Jane Elizabeth Smith","telecoms":[{"system":"EMAIL","value":"jane.smith@rockhurst.edu"}]},"registrationStatus":"OPEN","status":"ACTIVE","catalogs":[{"id":"cef0be9e-9bec-4f5e-8004-0252cab4b991"}],"scopes":[{"id":"gtf0tg5e-7hnt-44re-6623-2789htb4b465"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/event-series \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Screenings 2019","description":"Screening 2019 is a two-session event that involves body measurements and the collection of a small blood sample. The biometric screening results help provide detailed assessments of a person's health and improve health outcomes.","names":[{"locale":"en-US","value":"Localized value."}],"descriptions":[{"locale":"en-US","value":"Localized value."}],"leader":{"name":"Dr. Jane Elizabeth Smith","telecoms":[{"system":"EMAIL","value":"jane.smith@rockhurst.edu"}]},"registrationStatus":"OPEN","status":"ACTIVE","catalogs":[{"id":"cef0be9e-9bec-4f5e-8004-0252cab4b991"}],"scopes":[{"id":"gtf0tg5e-7hnt-44re-6623-2789htb4b465"}]}

POST /event-series

Creates a new event series, which groups events. An event series is used to link related events so they can be interacted with together.

Parameters

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

Response Statuses

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

Retrieve a List of Event Series


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/consumer-engagement/v1/event-series', headers: headers)

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "86bf670f-36bb-4b6a-b597-2c811353b4c6",
      "name": "Screenings 2019",
      "description": "Screening 2019 is a two-session event that involves body measurements and the collection of a small blood sample. The biometric screening results help provide detailed assessments of a person's health and improve health outcomes.",
      "names": [
        {
          "locale": "en-US",
          "value": "Localized value."
        }
      ],
      "descriptions": [
        {
          "locale": "en-US",
          "value": "Localized value."
        }
      ],
      "registrationStatus": "OPEN",
      "leader": {
        "name": "Dr. Jane Elizabeth Smith",
        "telecoms": [
          {
            "system": "EMAIL",
            "value": "jane.smith@rockhurst.edu"
          }
        ]
      },
      "catalogs": [
        {
          "id": "cef0be9e-9bec-4f5e-8004-0252cab4b991"
        }
      ],
      "scopes": [
        {
          "id": "gtf0tg5e-7hnt-44re-6623-2789htb4b465"
        }
      ],
      "status": "ACTIVE"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/event-series?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/event-series?offset=0&limit=20"
}

GET /event-series

Retrieves all of the event series that meet the specified parameters. Can be used to display available event series to consumers.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
from	query	string	false	N/A	Filters the retrieved series to only those with all events with at least one slot that starts on or after the specified date and time. The value must be in ISO 8601 YYYY-MM-DDThh:mm:ssZ format. If any event in the series starts after this date and time, the series is retrieved.	-
to	query	string	false	N/A	Filters the retrieved series to only those with all events with at least one slot that ends on or before the specified date and time. The value must be in ISO 8601 YYYY-MM-DDThh:mm:ssZ format. If any event in the series ends before this date and time, the series is retrieved.	-
categoryId	query	string	false	N/A	Filters by the ID of the category. If any event in the series is in this category, the series is retrieved.	-
locationId	query	string	false	N/A	Filters by the ID of the location. If any event in the series occurs at this location, the series is retrieved.	-
registrationStatus	query	string	false	N/A	Filters by the registration status of the series. If the registration status is OPEN, only series that take place in the future are returned.	-
catalogId	query	array[string]	false	N/A	Filters by the ID of the catalog. If any event in the series is in this catalog, the series is retrieved.	-
scopeId	query	array[string]	false	N/A	Filters by the ID of scope. If any event in the series is in this scope, the series is retrieved.	-
eventId	query	string	false	N/A	Filters by the ID of the event. If any event in the series has the ID that is specified for this query parameter, the series is retrieved.	-
status	query	string	false	N/A	Filters by the status of the event series.	-
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.	Series
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Update an Event Series




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/consumer-engagement/v1/event-series/86bf670f-36bb-4b6a-b597-2c811353b4c6', headers: headers, body: {"name":"Screenings 2019","description":"Screening 2019 is a two-session event that involves body measurements and the collection of a small blood sample. The biometric screening results help provide detailed assessments of a person's health and improve health outcomes.","names":[{"locale":"en-US","value":"Localized value."}],"descriptions":[{"locale":"en-US","value":"Localized value."}],"leader":{"name":"Dr. Jane Elizabeth Smith","telecoms":[{"system":"EMAIL","value":"jane.smith@rockhurst.edu"}]},"registrationStatus":"OPEN","status":"ACTIVE","catalogs":[{"id":"cef0be9e-9bec-4f5e-8004-0252cab4b991"}],"scopes":[{"id":"gtf0tg5e-7hnt-44re-6623-2789htb4b465"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/event-series/86bf670f-36bb-4b6a-b597-2c811353b4c6 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Screenings 2019","description":"Screening 2019 is a two-session event that involves body measurements and the collection of a small blood sample. The biometric screening results help provide detailed assessments of a person's health and improve health outcomes.","names":[{"locale":"en-US","value":"Localized value."}],"descriptions":[{"locale":"en-US","value":"Localized value."}],"leader":{"name":"Dr. Jane Elizabeth Smith","telecoms":[{"system":"EMAIL","value":"jane.smith@rockhurst.edu"}]},"registrationStatus":"OPEN","status":"ACTIVE","catalogs":[{"id":"cef0be9e-9bec-4f5e-8004-0252cab4b991"}],"scopes":[{"id":"gtf0tg5e-7hnt-44re-6623-2789htb4b465"}]}

PUT /event-series/{seriesId}

Updates the information for an event series. Any events that are included in this event series are not affected by this update.

Parameters

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

Response Statuses

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

Delete an Event Series


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/consumer-engagement/v1/event-series/86bf670f-36bb-4b6a-b597-2c811353b4c6', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/event-series/86bf670f-36bb-4b6a-b597-2c811353b4c6 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /event-series/{seriesId}

Deletes an event series. This request is intended for event series that are created in error. Event series with registrations cannot be deleted. If an event series has registrations, the event series should be updated to set the status field to CANCELLED.

Parameters

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

Response Statuses

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

Retrieve a Single Event Series


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/consumer-engagement/v1/event-series/86bf670f-36bb-4b6a-b597-2c811353b4c6', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/event-series/86bf670f-36bb-4b6a-b597-2c811353b4c6 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

GET /event-series/{seriesId}

Retrieves an event series by its ID. Can be used to retrieve information for a single event series.

Parameters

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

Response Statuses

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

Create an Event Registration




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/consumer-engagement/v1/event-registrations', headers: headers, body: {"consumer":{"id":"08f464c0-4ce1-4cec-8e3c-9107ea17a1d7"},"slot":{"id":"1914d1c6-43ca-4925-acd2-9183b3841312","event":{"id":"35eb9e2d-0bb4-4e30-8245-fd07525da9fe","seriesId":"11a3bbec-5378-47ac-89bb-b03b5dcec1cf"}}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/event-registrations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"consumer":{"id":"08f464c0-4ce1-4cec-8e3c-9107ea17a1d7"},"slot":{"id":"1914d1c6-43ca-4925-acd2-9183b3841312","event":{"id":"35eb9e2d-0bb4-4e30-8245-fd07525da9fe","seriesId":"11a3bbec-5378-47ac-89bb-b03b5dcec1cf"}}}

POST /event-registrations

Creates a new event registration, which reserves an event slot for a consumer. Can be used to plan for who is attending an event. When the event slot is full or the slot’s registration period is expired, an error is sent. If the associated event or event slot is updated, the event registration is retained.

Parameters

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

Response Statuses

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

Retrieve a List of Event Registrations


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/consumer-engagement/v1/event-registrations', headers: headers)

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "2c26d041-fb14-4d63-8d55-c59905c3de22",
      "consumer": {
        "id": "08f464c0-4ce1-4cec-8e3c-9107ea17a1d7"
      },
      "slot": {
        "id": "1914d1c6-43ca-4925-acd2-9183b3841312",
        "event": {
          "id": "35eb9e2d-0bb4-4e30-8245-fd07525da9fe",
          "seriesId": "11a3bbec-5378-47ac-89bb-b03b5dcec1cf"
        }
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/event-registrations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/event-registrations?offset=0&limit=20"
}

GET /event-registrations

Retrieves all of the event registrations that meet the specified parameters. Can be used to display event registrations to a consumer or to plan for an event.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
eventId	query	string	false	N/A	Filters by the ID of the event. If any event in the series has the ID that is specified for this query parameter, the series is retrieved.	-
seriesId	query	string	false	N/A	Filters by the ID of a series.	-
slotId	query	string	false	N/A	Filters by the ID of the event slot.	-
consumerId	query	string	false	N/A	Filters by the ID of the consumer.	-
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.	Registrations
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Delete an Event Registration


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/consumer-engagement/v1/event-registrations/2c26d041-fb14-4d63-8d55-c59905c3de22', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/event-registrations/2c26d041-fb14-4d63-8d55-c59905c3de22 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /event-registrations/{registrationId}

Deletes an event registration, which unregisters the consumer from the event slot.

Parameters

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

Response Statuses

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

Retrieve a Single Event Registration


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/consumer-engagement/v1/event-registrations/2c26d041-fb14-4d63-8d55-c59905c3de22', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/event-registrations/2c26d041-fb14-4d63-8d55-c59905c3de22 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

GET /event-registrations/{registrationId}

Retrieves a single event registration by its ID. Can be used to retrieve information for a single event registration.

Parameters

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

Response Statuses

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

Create a List of Event Attendances




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/consumer-engagement/v1/event-attendances', headers: headers, body: {"attendances":[{"consumer":{"id":"08f464c0-4ce1-4cec-8e3c-9107ea17a1d7"},"slot":{"id":"1914d1c6-43ca-4925-acd2-9183b3841312","event":{"id":"35eb9e2d-0bb4-4e30-8245-fd07525da9fe","seriesId":"11a3bbec-5378-47ac-89bb-b03b5dcec1cf"}}}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/event-attendances \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"attendances":[{"consumer":{"id":"08f464c0-4ce1-4cec-8e3c-9107ea17a1d7"},"slot":{"id":"1914d1c6-43ca-4925-acd2-9183b3841312","event":{"id":"35eb9e2d-0bb4-4e30-8245-fd07525da9fe","seriesId":"11a3bbec-5378-47ac-89bb-b03b5dcec1cf"}}}]}

POST /event-attendances

Creates a list of event attendance, which records that the consumer attended the event. An event registration is not required to create an event attendance. If multiple attendances are passed to this call, and a single attendance fails, no attendances will be created.

Parameters

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

Response Statuses

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

Retrieve a List of Event Attendances


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/consumer-engagement/v1/event-attendances', headers: headers)

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "e9c16850-0082-47eb-b091-ae4db5c70ecb",
      "consumer": {
        "id": "08f464c0-4ce1-4cec-8e3c-9107ea17a1d7"
      },
      "slot": {
        "id": "1914d1c6-43ca-4925-acd2-9183b3841312",
        "event": {
          "id": "35eb9e2d-0bb4-4e30-8245-fd07525da9fe",
          "seriesId": "11a3bbec-5378-47ac-89bb-b03b5dcec1cf"
        }
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/event-attendances?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/event-attendances?offset=0&limit=20"
}

GET /event-attendances

Retrieves all of the event attendances for an event that meet the specified parameters. Can be used to display event attendances for a consumer or to log who attended an event.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
eventId	query	string	false	N/A	Filters by the ID of the event. If any event in the series has the ID that is specified for this query parameter, the series is retrieved.	-
seriesId	query	string	false	N/A	Filters by the ID of a series.	-
slotId	query	string	false	N/A	Filters by the ID of the event slot.	-
consumerId	query	string	false	N/A	Filters by the ID of the consumer.	-
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.	Attendances
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Delete an Event Attendance


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/consumer-engagement/v1/event-attendances/e9c16850-0082-47eb-b091-ae4db5c70ecb', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/event-attendances/e9c16850-0082-47eb-b091-ae4db5c70ecb \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /event-attendances/{attendanceId}

Deletes an event attendance, which indicates that the consumer did not attend the event.

Parameters

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

Response Statuses

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

Retrieve a Single Event Attendance


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/consumer-engagement/v1/event-attendances/e9c16850-0082-47eb-b091-ae4db5c70ecb', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/event-attendances/e9c16850-0082-47eb-b091-ae4db5c70ecb \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

GET /event-attendances/{attendanceId}

Retrieves a single event attendance by its ID. Used to retrieve information for a single event attendance.

Parameters

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

Response Statuses

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

Create an Event Scope




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/consumer-engagement/v1/event-scopes', headers: headers, body: {"name":"2020 Incentivized Events Scope","kind":"Scope to group incentivized events in 2020.","consumerGroups":[{"id":"ea133b83-176c-4c7f-9f49-892521605164"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/event-scopes \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"2020 Incentivized Events Scope","kind":"Scope to group incentivized events in 2020.","consumerGroups":[{"id":"ea133b83-176c-4c7f-9f49-892521605164"}]}

POST /event-scopes

Creates a new event scope that can group events and event series. Events and event series can be included in event scopes to group the events and event series. To remove an event or event series from an event scope, the event or event series must be updated to remove the event scope reference.

Parameters

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

Response Statuses

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

Retrieve a List of Event Scopes


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/consumer-engagement/v1/event-scopes', headers: headers)

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "gtf0tg5e-7hnt-44re-6623-2789htb4b465",
      "name": "2020 Incentivized Events Scope",
      "kind": "Scope to group incentivized events in 2020.",
      "consumerGroups": [
        {
          "id": "ea133b83-176c-4c7f-9f49-892521605164"
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/event-scopes?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/event-scopes?offset=0&limit=20"
}

GET /event-scopes

Retrieves all of the event scopes that can group events and event series.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
consumerGroupId	query	array[string]	false	N/A	Filters by the ID of the consumer 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.	Scopes
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Delete an Event Scope


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/consumer-engagement/v1/event-scopes/gtf0tg5e-7hnt-44re-6623-2789htb4b465', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/event-scopes/gtf0tg5e-7hnt-44re-6623-2789htb4b465 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /event-scopes/{scopeId}

Deletes the single scope with the specified ID.

Parameters

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

Response Statuses

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

Update an Event Scope




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/consumer-engagement/v1/event-scopes/gtf0tg5e-7hnt-44re-6623-2789htb4b465', headers: headers, body: {"name":"2020 Incentivized Events Scope","kind":"Scope to group incentivized events in 2020.","consumerGroups":[{"id":"ea133b83-176c-4c7f-9f49-892521605164"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/event-scopes/gtf0tg5e-7hnt-44re-6623-2789htb4b465 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"2020 Incentivized Events Scope","kind":"Scope to group incentivized events in 2020.","consumerGroups":[{"id":"ea133b83-176c-4c7f-9f49-892521605164"}]}

PUT /event-scopes/{scopeId}

Updates the information for an event scope.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
scopeId	path	string	true	N/A	The ID of the scope.	-
body	body	putEventScopes	true	N/A	No description	-

Response Statuses

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

Retrieve a Single Event Scope


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/consumer-engagement/v1/event-scopes/gtf0tg5e-7hnt-44re-6623-2789htb4b465', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/event-scopes/gtf0tg5e-7hnt-44re-6623-2789htb4b465 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

GET /event-scopes/{scopeId}

Retrieves an event scope by its ID. This is used to retrieve information for a single event scope.

Parameters

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

Response Statuses

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

Create an Event 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/consumer-engagement/v1/event-email-notifications', headers: headers, body: {"eventId":"94b44ea3-fb6b-4245-886b-caa8e156f125","locale":"en-US","emailSubject":"Take the First Step to Investing","emailBody":"<!DOCTYPE html>\\n<html lang=\\\"en\\\">\\n <head>\\n <meta charset=\\\"utf-8\\\" />\\n <p> Hi {{first_name}},</p>\\n <p> <html>Join Fidelity, our 401(k) record keeper, as they dive into investing. Learn key investing concepts, common investment types and how to choose your investment approach</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/consumer-engagement/v1/event-email-notifications \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"eventId":"94b44ea3-fb6b-4245-886b-caa8e156f125","locale":"en-US","emailSubject":"Take the First Step to Investing","emailBody":"<!DOCTYPE html>\\n<html lang=\\\"en\\\">\\n <head>\\n <meta charset=\\\"utf-8\\\" />\\n <p> Hi {{first_name}},</p>\\n <p> <html>Join Fidelity, our 401(k) record keeper, as they dive into investing. Learn key investing concepts, common investment types and how to choose your investment approach</html>.</p>\\n","sendNotificationOn":"2020-03-05"}

{
  "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
  "locale": "en-US",
  "eventId": "94b44ea3-fb6b-4245-886b-caa8e156f125",
  "emailSubject": "Things to do before ths start of event.",
  "emailBody": "<!DOCTYPE html>\\n<html lang=\\\"en\\\">\\n <head>\\n <meta charset=\\\"utf-8\\\" />\\n <p> Hi {{first_name}},</p>\\n <p> <html>Event begins in 3 days. Check out the things to complete before the start of this event</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 /event-email-notifications

Creates an event email notification. Email notifications are sent to all consumers registered in the event. 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	postEventEmailNotifications	true	N/A	No description	-

Response Statuses

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

Retrieve a List of Event 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/consumer-engagement/v1/event-email-notifications', headers: headers)

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
      "locale": "en-US",
      "eventId": "94b44ea3-fb6b-4245-886b-caa8e156f125",
      "emailSubject": "Things to do before ths start of event.",
      "emailBody": "<!DOCTYPE html>\\n<html lang=\\\"en\\\">\\n <head>\\n <meta charset=\\\"utf-8\\\" />\\n <p> Hi {{first_name}},</p>\\n <p> <html>Event begins in 3 days. Check out the things to complete before the start of this event</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/consumer-engagement/v1/event-email-notifications?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/event-email-notifications?offset=0&limit=20"
}

GET /event-email-notifications

Retrieves a list of event email notifications.

Parameters

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

Response Statuses

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

Delete an Event 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/consumer-engagement/v1/event-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/consumer-engagement/v1/event-email-notifications/1a857d33-5b74-4c76-9a60-a008ea652cc6 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /event-email-notifications/{eventEmailNotificationId}

Deletes the event 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
eventEmailNotificationId	path	string	true	N/A	The ID of an event 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 Event 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/consumer-engagement/v1/event-email-notifications/1a857d33-5b74-4c76-9a60-a008ea652cc6', headers: headers, body: {"eventId":"94b44ea3-fb6b-4245-886b-caa8e156f125","locale":"en-US","emailSubject":"Take the First Step to Investing","emailBody":"<!DOCTYPE html>\\n<html lang=\\\"en\\\">\\n <head>\\n <meta charset=\\\"utf-8\\\" />\\n <p> Hi {{first_name}},</p>\\n <p> <html>Join Fidelity, our 401(k) record keeper, as they dive into investing. Learn key investing concepts, common investment types and how to choose your investment approach</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/consumer-engagement/v1/event-email-notifications/1a857d33-5b74-4c76-9a60-a008ea652cc6 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"eventId":"94b44ea3-fb6b-4245-886b-caa8e156f125","locale":"en-US","emailSubject":"Take the First Step to Investing","emailBody":"<!DOCTYPE html>\\n<html lang=\\\"en\\\">\\n <head>\\n <meta charset=\\\"utf-8\\\" />\\n <p> Hi {{first_name}},</p>\\n <p> <html>Join Fidelity, our 401(k) record keeper, as they dive into investing. Learn key investing concepts, common investment types and how to choose your investment approach</html>.</p>\\n","sendNotificationOn":"2020-03-05"}

PUT /event-email-notifications/{eventEmailNotificationId}

Updates the event email notification with the specified ID using the given data. If an event email notification is in progress or sent, it can no longer be updated.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
eventEmailNotificationId	path	string	true	N/A	The ID of an event email notification.	-
body	body	putEventEmailNotifications	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 Event 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/consumer-engagement/v1/event-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/consumer-engagement/v1/event-email-notifications/1a857d33-5b74-4c76-9a60-a008ea652cc6 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
  "locale": "en-US",
  "eventId": "94b44ea3-fb6b-4245-886b-caa8e156f125",
  "emailSubject": "Things to do before ths start of event.",
  "emailBody": "<!DOCTYPE html>\\n<html lang=\\\"en\\\">\\n <head>\\n <meta charset=\\\"utf-8\\\" />\\n <p> Hi {{first_name}},</p>\\n <p> <html>Event begins in 3 days. Check out the things to complete before the start of this event</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 /event-email-notifications/{eventEmailNotificationId}

Retrieves a single event email notification by ID.

Parameters

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

Response Statuses

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

Learning Module

A learning module is an organized collection of educational content.

Create a Learning Module




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/consumer-engagement/v1/learning-modules', headers: headers, body: {"definitionId":"77a233a3-54d4-4ad3-9e63-53bb71762290","imageUrl":"https://heathwise.edu/1.jpg","title":[{"locale":"en-US","text":"Diabetes Prevention"}],"description":[{"locale":"en-US","text":"A 12-week course to help you establish healthy weight practices and habits."}],"keywords":[{"locale":"en-US","text":["Diabetes","prevention"]}],"categories":["0276ea55-a3cc-4b0a-88dc-284629d"],"catalogs":[{"id":"7eddc0ad-dc15-4746-9a5c-73f1ea680f83"}],"consumerGroups":[{"id":"0276ea55-a3cc-4b0a-88dc-284629d6"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/learning-modules \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"definitionId":"77a233a3-54d4-4ad3-9e63-53bb71762290","imageUrl":"https://heathwise.edu/1.jpg","title":[{"locale":"en-US","text":"Diabetes Prevention"}],"description":[{"locale":"en-US","text":"A 12-week course to help you establish healthy weight practices and habits."}],"keywords":[{"locale":"en-US","text":["Diabetes","prevention"]}],"categories":["0276ea55-a3cc-4b0a-88dc-284629d"],"catalogs":[{"id":"7eddc0ad-dc15-4746-9a5c-73f1ea680f83"}],"consumerGroups":[{"id":"0276ea55-a3cc-4b0a-88dc-284629d6"}]}

{
  "id": "11e8902c9e2908c69718f13503066bee",
  "definitionId": "77a233a3-54d4-4ad3-9e63-53bb71762290",
  "title": [
    {
      "locale": "en-US",
      "text": "Diabetes Prevention"
    }
  ],
  "description": [
    {
      "locale": "en-US",
      "text": "Diabetes Prevention"
    }
  ],
  "status": "DRAFT",
  "type": "CUSTOM",
  "imageUrl": "https://heathwise.edu/1.jpg",
  "keywords": [
    {
      "locale": "en-US",
      "text": [
        "Diabetes",
        "prevention"
      ]
    }
  ],
  "categories": [
    "0276ea55-a3cc-4b0a-88dc-284629d"
  ],
  "catalogs": [
    {
      "id": "7eddc0ad-dc15-4746-9a5c-73f1ea680f83"
    }
  ],
  "consumerGroups": [
    {
      "id": "0276ea55-a3cc-4b0a-88dc-284629d6"
    }
  ],
  "createdAt": "2018-12-15T12:23:12Z",
  "updatedAt": "2018-12-15T12:23:12Z"
}

POST /learning-modules

Creates a learning module.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
201	Created	The learning module was created.	ConsumerEngagementPublicApi_Entities_V1_LearningModules_Module
400	Bad Request	Bad Request. The learning module was not created. The response includes error details with a reason field that can help identify the issue. The following reasons are possible, among others: - `noDefaultLocale` The default locale (en-US) is required for the title. - `duplicateLocale` The locale for the provided titles and descriptions must be unique. - `missingTitle` Title is required. Specify a title for the locale and description to continue. - `catgoryNotFound` The category was not found.	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Retrieve a List of Learning Modules


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/consumer-engagement/v1/learning-modules', headers: headers)

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "11e8902c9e2908c69718f13503066bee",
      "title": [
        {
          "locale": "en-US",
          "text": "Diabetes Prevention"
        }
      ],
      "description": [
        {
          "locale": "en-US",
          "text": "A 12-week course to help you establish healthy weight practices and habits."
        }
      ],
      "status": "PUBLISHED",
      "type": "CUSTOM",
      "imageUrl": "https://heathwise.edu/1.jpg",
      "keywords": [
        {
          "locale": "en-US",
          "text": [
            "Diabetes",
            "prevention"
          ]
        }
      ],
      "categories": [
        "0276ea55-a3cc-4b0a-88dc-284629d"
      ],
      "catalogs": [
        {
          "id": "7eddc0ad-dc15-4746-9a5c-73f1ea680f83"
        }
      ],
      "consumerGroups": [
        {
          "id": "0276ea55-a3cc-4b0a-88dc-284629d6"
        }
      ],
      "createdAt": "2018-12-15T12:23:12Z",
      "updatedAt": "2018-12-15T12:23:12Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/learning-modules?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/learning-modules?offset=0&limit=20"
}

GET /learning-modules

Retrieves a list of learning modules.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
ids	query	array[string]	false	N/A	Filters modules by module IDs.	-
categoryIds	query	array[string]	false	N/A	Filters modules by category IDs.	-
keywords	query	array[string]	false	N/A	Filters modules by keywords.	-
searchTerms	query	string	false	N/A	Filters the retrieved modules to those that contain specific text. Partial matching is supported.	-
status	query	array[string]	false	N/A	Filters modules by status.	DRAFT, PUBLISHED, RETIRED
type	query	string	false	N/A	Filters modules by type.	STANDARD, CUSTOM
catalogId	query	array[string]	false	N/A	Filters modules by catalog ID.	-
consumerGroupId	query	array[string]	false	N/A	Filters modules by consumer group ID.	-
offset	query	integer(int32)	false	0	The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset.	-
limit	query	integer(int32)	false	20	The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100.	-
locale	query	string	false	en-US	Filters modules by locale.	-
orderBy	query	string	false	updatedAt	A comma-separated list of fields by which to sort.	updatedAt, -updatedAt, createdAt, -createdAt, status, title, -title

Response Statuses

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

Delete a Learning Module


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/consumer-engagement/v1/learning-modules/11e8902c9e2908c69718f13503066bee', headers: headers)

print JSON.pretty_generate(result)


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

DELETE /learning-modules/{moduleId}

Deletes a single learning module by ID.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
moduleId	path	string	true	N/A	The module ID.	-

Response Statuses

Status	Meaning	Description	Schema
204	No Content	The module was deleted.	None
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Update a Learning Module




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/consumer-engagement/v1/learning-modules/11e8902c9e2908c69718f13503066bee', headers: headers, body: {"imageUrl":"https://heathwise.edu/1.jpg","status":"PUBLISHED","title":[{"locale":"en-US","text":"Diabetes Prevention"}],"description":[{"locale":"en-US","text":"A 12-week course to help you establish healthy weight practices and habits."}],"keywords":[{"locale":"en-US","text":["Diabetes","prevention"]}],"categories":["0276ea55-a3cc-4b0a-88dc-284629d"],"catalogs":[{"id":"7eddc0ad-dc15-4746-9a5c-73f1ea680f83"}],"consumerGroups":[{"id":"0276ea55-a3cc-4b0a-88dc-284629d6"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PATCH https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/learning-modules/11e8902c9e2908c69718f13503066bee \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"imageUrl":"https://heathwise.edu/1.jpg","status":"PUBLISHED","title":[{"locale":"en-US","text":"Diabetes Prevention"}],"description":[{"locale":"en-US","text":"A 12-week course to help you establish healthy weight practices and habits."}],"keywords":[{"locale":"en-US","text":["Diabetes","prevention"]}],"categories":["0276ea55-a3cc-4b0a-88dc-284629d"],"catalogs":[{"id":"7eddc0ad-dc15-4746-9a5c-73f1ea680f83"}],"consumerGroups":[{"id":"0276ea55-a3cc-4b0a-88dc-284629d6"}]}

PATCH /learning-modules/{moduleId}

Updates a learning module.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
moduleId	path	string	true	N/A	The module ID.	-
body	body	patchLearningModules	true	N/A	No description	-

Response Statuses

Status	Meaning	Description	Schema
204	No Content	The module was updated.	None
400	Bad Request	Bad Request. The education content was not updated. The response includes error details with a reason field that can help identify the issue. The following reasons are possible, among others: - `noDefaultLocale` The default locale (en-US) is required for the title if it is used in the body. - `duplicateLocale` The locales for the titles and descriptions must be unique. - `categoryNotFound` The category was not found.	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error
409	Conflict	Conflict	Error

Retrieve a Single Module


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/consumer-engagement/v1/learning-modules/11e8902c9e2908c69718f13503066bee', headers: headers)

print JSON.pretty_generate(result)


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

{
  "id": "11e8902c9e2908c69718f13503066bee",
  "definitionId": "77a233a3-54d4-4ad3-9e63-53bb71762290",
  "title": [
    {
      "locale": "en-US",
      "text": "Diabetes Prevention"
    }
  ],
  "description": [
    {
      "locale": "en-US",
      "text": "Diabetes Prevention"
    }
  ],
  "status": "DRAFT",
  "type": "CUSTOM",
  "imageUrl": "https://heathwise.edu/1.jpg",
  "keywords": [
    {
      "locale": "en-US",
      "text": [
        "Diabetes",
        "prevention"
      ]
    }
  ],
  "categories": [
    "0276ea55-a3cc-4b0a-88dc-284629d"
  ],
  "catalogs": [
    {
      "id": "7eddc0ad-dc15-4746-9a5c-73f1ea680f83"
    }
  ],
  "consumerGroups": [
    {
      "id": "0276ea55-a3cc-4b0a-88dc-284629d6"
    }
  ],
  "createdAt": "2018-12-15T12:23:12Z",
  "updatedAt": "2018-12-15T12:23:12Z"
}

GET /learning-modules/{moduleId}

Retrieves a single module by ID.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
moduleId	path	string	true	N/A	The module ID.	-

Response Statuses

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

Copy a Learning Module


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/consumer-engagement/v1/learning-modules/{moduleId}/clone', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/learning-modules/{moduleId}/clone \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "11e8902c9e2908c69718f13503066bee",
  "definitionId": "77a233a3-54d4-4ad3-9e63-53bb71762290",
  "title": [
    {
      "locale": "en-US",
      "text": "Diabetes Prevention"
    }
  ],
  "description": [
    {
      "locale": "en-US",
      "text": "Diabetes Prevention"
    }
  ],
  "status": "DRAFT",
  "type": "CUSTOM",
  "imageUrl": "https://heathwise.edu/1.jpg",
  "keywords": [
    {
      "locale": "en-US",
      "text": [
        "Diabetes",
        "prevention"
      ]
    }
  ],
  "categories": [
    "0276ea55-a3cc-4b0a-88dc-284629d"
  ],
  "catalogs": [
    {
      "id": "7eddc0ad-dc15-4746-9a5c-73f1ea680f83"
    }
  ],
  "consumerGroups": [
    {
      "id": "0276ea55-a3cc-4b0a-88dc-284629d6"
    }
  ],
  "createdAt": "2018-12-15T12:23:12Z",
  "updatedAt": "2018-12-15T12:23:12Z"
}

POST /learning-modules/{moduleId}/clone

Copies a learning module with a specified ID to create a new learning module and its associated tasks.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
moduleId	path	string	true	N/A	The module ID.	-

Response Statuses

Status	Meaning	Description	Schema
201	Created	The learning module was cloned.	ConsumerEngagementPublicApi_Entities_V1_LearningModules_Module
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a Task




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/consumer-engagement/v1/learning-modules/11e8902c9e2908c69718f13503066bee/tasks', headers: headers, body: {"title":[{"locale":"en-US","text":"Diabetes Prevention"}],"description":[{"locale":"en-US","text":"A 12-week course to help you establish healthy weight practices and habits."}],"sourceReference":{"id":"d8454f2a-665c-49d4-87db-8c167feae10e","kind":"education#content"},"order":"4","weeksBeforeActive":1}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/learning-modules/11e8902c9e2908c69718f13503066bee/tasks \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"title":[{"locale":"en-US","text":"Diabetes Prevention"}],"description":[{"locale":"en-US","text":"A 12-week course to help you establish healthy weight practices and habits."}],"sourceReference":{"id":"d8454f2a-665c-49d4-87db-8c167feae10e","kind":"education#content"},"order":"4","weeksBeforeActive":1}

{
  "id": "d4454f2a-665c-49d4-87db-8c167feae17d",
  "moduleReference": {
    "id": "11e8902c9e2908c69718f13503066bee"
  },
  "title": [
    {
      "locale": "en-US",
      "text": "Diabetes Prevention"
    }
  ],
  "description": [
    {
      "locale": "en-US",
      "text": "A 12-week course to help you establish healthy weight practices and habits."
    }
  ],
  "sourceReference": {
    "id": "d8454f2a-665c-49d4-87db-8c167feae10e",
    "kind": "education#content"
  },
  "order": "4",
  "weeksBeforeActive": 1,
  "createdAt": "2018-12-15T12:23:12Z",
  "updatedAt": "2018-12-15T12:23:12Z"
}

POST /learning-modules/{moduleId}/tasks

Creates a task in the learning module.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
moduleId	path	string	true	N/A	The module ID.	-
body	body	postLearningModulesModuleidTasks	true	N/A	No description	-

Response Statuses

Status	Meaning	Description	Schema
201	Created	The learning module task was created.	ConsumerEngagementPublicApi_Entities_V1_LearningModules_Task
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Retrieve a List of Tasks for a Learning Module


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/consumer-engagement/v1/learning-modules/11e8902c9e2908c69718f13503066bee/tasks', headers: headers)

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "d4454f2a-665c-49d4-87db-8c167feae17d",
      "moduleReference": {
        "id": "11e8902c9e2908c69718f13503066bee"
      },
      "title": [
        {
          "locale": "en-US",
          "text": "Diabetes Prevention"
        }
      ],
      "description": [
        {
          "locale": "en-US",
          "text": "A 12-week course to help you establish healthy weight practices and habits."
        }
      ],
      "sourceReference": {
        "id": "d8454f2a-665c-49d4-87db-8c167feae10e",
        "kind": "education#content"
      },
      "order": "4",
      "weeksBeforeActive": 1,
      "createdAt": "2018-12-15T12:23:12Z",
      "updatedAt": "2018-12-15T12:23:12Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/learning-modules/db5f4eec-0e29-40b4-b051-707ad8a30b1d/tasks?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/learning-modules/db5f4eec-0e29-40b4-b051-707ad8a30b1d/tasks?offset=0&limit=20"
}

GET /learning-modules/{moduleId}/tasks

Retrieves a list of tasks for a learning module.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
moduleId	path	string	true	N/A	The module ID.	-
sourceReferenceId	query	string	false	N/A	The source ID in an external system, for example, the education library.	-
sourceReferenceKind	query	string	false	N/A	The source type in an external system, for example, the education library.	-
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.	-
locale	query	string	false	en-US	Filters modules by locale.	-
orderBy	query	string	false	updatedAt	A comma-separated list of fields by which to sort.	updatedAt, -updatedAt

Response Statuses

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

Delete a Task


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/consumer-engagement/v1/learning-modules/11e8902c9e2908c69718f13503066bee/tasks/42f0931e-d05d-458d-a835-cf6bc4795158', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/learning-modules/11e8902c9e2908c69718f13503066bee/tasks/42f0931e-d05d-458d-a835-cf6bc4795158 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /learning-modules/{moduleId}/tasks/{taskId}

Deletes a single task in a learning module.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
moduleId	path	string	true	N/A	The module ID.	-
taskId	path	string	true	N/A	The ID of the module task.	-

Response Statuses

Status	Meaning	Description	Schema
204	No Content	The task was deleted.	None
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Update a Task




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/consumer-engagement/v1/learning-modules/11e8902c9e2908c69718f13503066bee/tasks/42f0931e-d05d-458d-a835-cf6bc4795158', headers: headers, body: {"title":[{"locale":"en-US","text":"Diabetes Prevention"}],"sourceReference":{"id":"d8454f2a-665c-49d4-87db-8c167feae10e","kind":"education#content"},"order":"4","weeksBeforeActive":1,"description":[{"locale":"en-US","text":"A 12-week course to help you establish healthy weight practices and habits."}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PATCH https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/learning-modules/11e8902c9e2908c69718f13503066bee/tasks/42f0931e-d05d-458d-a835-cf6bc4795158 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"title":[{"locale":"en-US","text":"Diabetes Prevention"}],"sourceReference":{"id":"d8454f2a-665c-49d4-87db-8c167feae10e","kind":"education#content"},"order":"4","weeksBeforeActive":1,"description":[{"locale":"en-US","text":"A 12-week course to help you establish healthy weight practices and habits."}]}

PATCH /learning-modules/{moduleId}/tasks/{taskId}

Updates a single task in a learning module.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
moduleId	path	string	true	N/A	The module ID.	-
taskId	path	string	true	N/A	The ID of the module task.	-
body	body	patchLearningModulesModuleidTasks	true	N/A	No description	-

Response Statuses

Status	Meaning	Description	Schema
204	No Content	The task was updated.	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

Add a Consumer to a Module




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/consumer-engagement/v1/learning-module-enrollments', headers: headers, body: {"moduleReferenceId":"11e8902c9e2908c69718f13503066bee","consumerReferenceId":"9fb56347-07bd-4a48-a495-fc86ef804ba7"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/learning-module-enrollments \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"moduleReferenceId":"11e8902c9e2908c69718f13503066bee","consumerReferenceId":"9fb56347-07bd-4a48-a495-fc86ef804ba7"}

{
  "id": "6fcfc048-77ab-4f8b-831f-52dbb64b906b",
  "consumerReference": {
    "id": "9fb56347-07bd-4a48-a495-fc86ef804ba7"
  },
  "moduleReference": {
    "id": "11e8902c9e2908c69718f13503066bee"
  },
  "status": "notStarted",
  "createdAt": "2018-12-15T12:23:12Z",
  "updatedAt": "2018-12-15T12:23:12Z"
}

POST /learning-module-enrollments

Creates a wellness learning module enrollment, which enrolls the consumer in the module.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
201	Created	The learning enrollment was created.	ConsumerEngagementPublicApi_Entities_V1_LearningModules_Enrollment
400	Bad Request	Bad Request. The learning module was not created due to issues with the request. The request should be reattempted. The response includes error details with a reason field that can help identify the issue. The following reasons are possible, among others: - `consumerAlreadyEnrolled` The person is already enrolled in the learning module. - `invalidField` A field is incorrect in some way, for example, the data type is incorrect. - `missingField` Review and complete all required information to continue.	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Retrieve a List of Enrolled Wellness Learning Modules


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/consumer-engagement/v1/learning-module-enrollments', headers: headers)

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "6fcfc048-77ab-4f8b-831f-52dbb64b906b",
      "consumerReference": {
        "id": "9fb56347-07bd-4a48-a495-fc86ef804ba7"
      },
      "moduleReference": {
        "id": "11e8902c9e2908c69718f13503066bee"
      },
      "status": "notStarted",
      "createdAt": "2018-12-15T12:23:12Z",
      "updatedAt": "2018-12-15T12:23:12Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/learning-module-enrollments?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/learning-module-enrollments?offset=0&limit=20"
}

GET /learning-module-enrollments

Retrieves a list of the modules in which a consumer is enrolled.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
consumerReferenceId	query	string	false	N/A	Filters enrollments by consumer ID.	-
moduleReferenceId	query	string	false	N/A	Filters enrollments by learning module ID.	-
status	query	array[string]	false	N/A	Filters enrollments by status.	notStarted, inProgress, completed, unenrolled
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.	updatedAt, -updatedAt

Response Statuses

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

Remove a Consumer from a Module


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/consumer-engagement/v1/learning-module-enrollments/66886ed6-cfde-427c-9384-bc0995dc3a7e', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/learning-module-enrollments/66886ed6-cfde-427c-9384-bc0995dc3a7e \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /learning-module-enrollments/{enrollmentId}

Deletes a learning module enrollment, which unenrolls a consumer from a module.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
enrollmentId	path	string	true	N/A	The enrollment ID.	-

Response Statuses

Status	Meaning	Description	Schema
204	No Content	The enrollment was deleted.	None
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Retrieve a Wellness Learning Module 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/consumer-engagement/v1/learning-module-enrollments/66886ed6-cfde-427c-9384-bc0995dc3a7e', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/learning-module-enrollments/66886ed6-cfde-427c-9384-bc0995dc3a7e \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "6fcfc048-77ab-4f8b-831f-52dbb64b906b",
  "consumerReference": {
    "id": "9fb56347-07bd-4a48-a495-fc86ef804ba7"
  },
  "moduleReference": {
    "id": "11e8902c9e2908c69718f13503066bee"
  },
  "status": "notStarted",
  "createdAt": "2018-12-15T12:23:12Z",
  "updatedAt": "2018-12-15T12:23:12Z"
}

GET /learning-module-enrollments/{enrollmentId}

Retrieves a single wellness learning module enrollment by ID.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
enrollmentId	path	string	true	N/A	The enrollment ID.	-

Response Statuses

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

Retrieve a List of Tasks


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/consumer-engagement/v1/learning-module-enrollments/66886ed6-cfde-427c-9384-bc0995dc3a7e/tasks', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/learning-module-enrollments/66886ed6-cfde-427c-9384-bc0995dc3a7e/tasks \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "f35241f0-968d-46bb-8ee0-f59818892c61",
      "moduleTaskReference": {
        "id": "d4454f2a-665c-49d4-87db-8c167feae17d"
      },
      "status": "NOT_STARTED",
      "order": "4",
      "taskActivity": {
        "id": "21c2341c-a273-4103-92f0-028653384bea"
      },
      "createdAt": "2018-12-15T12:23:12Z",
      "updatedAt": "2018-12-15T12:23:12Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/learning-module-enrollments/11e8902c9e2908c69718/tasks?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/learning-module-enrollments/11e8902c9e2908c69718/tasks?offset=0&limit=20"
}

GET /learning-module-enrollments/{enrollmentId}/tasks

Retrieves a list of tasks for a specific module in which a consumer is enrolled.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
enrollmentId	path	string	true	N/A	The enrollment ID.	-
status	query	string	false	N/A	Filters enrollments by status.	NOT_STARTED, COMPLETED
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	order	A comma-separated list of fields by which to sort.	updatedAt, -updatedAt, order, -order, status

Response Statuses

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

Update a Task Status




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/consumer-engagement/v1/learning-module-enrollments/66886ed6-cfde-427c-9384-bc0995dc3a7e/tasks/d96a3cd2-01c1-4abf-aa1b-9be4605bfaed', headers: headers, body: {"status":"completed","taskActivity":{"id":"21c2341c-a273-4103-92f0-028653384bea"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PATCH https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/learning-module-enrollments/66886ed6-cfde-427c-9384-bc0995dc3a7e/tasks/d96a3cd2-01c1-4abf-aa1b-9be4605bfaed \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"status":"completed","taskActivity":{"id":"21c2341c-a273-4103-92f0-028653384bea"}}

PATCH /learning-module-enrollments/{enrollmentId}/tasks/{enrollmentTaskId}

Updates the status of a task in a learning module in which a consumer is enrolled.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
enrollmentId	path	string	true	N/A	The enrollment ID.	-
enrollmentTaskId	path	string	true	N/A	The enrollment ID of the learning module task.	-
body	body	patchLearningModuleEnrollmentsEnrollmentidTasks	true	N/A	No description	-

Response Statuses

Status	Meaning	Description	Schema
204	No Content	No Content	ConsumerEngagementPublicApi_Entities_V1_LearningModules_Enrollment
400	Bad Request	Bad Request. The resource cannot be updated due to issues with the request. The request should be reattempted. The response includes error details with a reason field that can help identify the issue. The following reasons are possible, among others: - `statusEnrollmentIssue` The learning module is already in the specified status. - `invalidField` A field is incorrect in some way, for example, the data type is incorrect.	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error
409	Conflict	Conflict	Error

Create a Category




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/consumer-engagement/v1/learning-module-categories', headers: headers, body: {"title":[{"text":"Diabetes Prevention","locale":"en-US"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/learning-module-categories \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"title":[{"text":"Diabetes Prevention","locale":"en-US"}]}

{
  "id": "11e8902c9e2908c69718f13503066bee",
  "title": [
    {
      "locale": "en-US",
      "text": "Diabetes Prevention"
    }
  ],
  "createdAt": "2018-12-15T12:23:12Z",
  "updatedAt": "2018-05-15T12:23:12Z"
}

POST /learning-module-categories

Creates a category.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
201	Created	The category was created.	ConsumerEngagementPublicApi_Entities_V1_LearningModules_LearningModuleCategory
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Retrieve a List of Categories


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/consumer-engagement/v1/learning-module-categories', headers: headers)

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "11e8902c9e2908c69718f13503066bee",
      "title": [
        {
          "locale": "en-US",
          "text": "Diabetes Prevention"
        }
      ],
      "createdAt": "2018-12-15T12:23:12Z",
      "updatedAt": "2018-05-15T12:23:12Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/learning-module-categories?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/learning-module-categories?offset=0&limit=20"
}

GET /learning-module-categories

Retrieves a list of categories.

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.	-
orderBy	query	string	false	updatedAt	A comma-separated list of fields by which to sort.	updatedAt, -updatedAt

Response Statuses

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

Update a Category




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/consumer-engagement/v1/learning-module-categories/11e8902c9e2908c69718f13503066bee', headers: headers, body: {"title":[{"text":"Diabetes Prevention","locale":"en-US"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PATCH https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/learning-module-categories/11e8902c9e2908c69718f13503066bee \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"title":[{"text":"Diabetes Prevention","locale":"en-US"}]}

PATCH /learning-module-categories/{categoryId}

Updates a category.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
categoryId	path	string	true	N/A	The ID of the category.	-
body	body	patchLearningModuleCategories	true	N/A	No description	-

Response Statuses

Status	Meaning	Description	Schema
204	No Content	The category was updated.	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

Delete a Category


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/consumer-engagement/v1/learning-module-categories/11e8902c9e2908c69718f13503066bee', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/learning-module-categories/11e8902c9e2908c69718f13503066bee \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /learning-module-categories/{categoryId}

Deletes a single category.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
204	No Content	The category was deleted.	None
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Retrieve a Single Category


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/consumer-engagement/v1/learning-module-categories/11e8902c9e2908c69718f13503066bee', headers: headers)

print JSON.pretty_generate(result)


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

{
  "id": "11e8902c9e2908c69718f13503066bee",
  "title": [
    {
      "locale": "en-US",
      "text": "Diabetes Prevention"
    }
  ],
  "createdAt": "2018-12-15T12:23:12Z",
  "updatedAt": "2018-05-15T12:23:12Z"
}

GET /learning-module-categories/{categoryId}

Retrieves a single category by ID.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
categoryId	path	string	true	N/A	The ID of the category.	-
locale	query	string	false	en-US	Filters modules by locale.	-

Response Statuses

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

Create a Learning Module Catalog




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/consumer-engagement/v1/learning-module-catalogs', headers: headers, body: {"name":"2019 Incentivized Learning Module Catalog","description":"Catalog to group incentivized learning modules in 2019."}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/learning-module-catalogs \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"2019 Incentivized Learning Module Catalog","description":"Catalog to group incentivized learning modules in 2019."}

POST /learning-module-catalogs

Creates a new learning module catalog. Learning modules can be included in learning module catalogs to group the learning modules. To remove a learning module from a learning module catalog, the learning module must be updated to remove the learning module catalog reference.

Parameters

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

Response Statuses

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

Retrieve a List of learning Module Catalogs


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/consumer-engagement/v1/learning-module-catalogs', headers: headers)

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "cef0be9e-9bec-4f5e-8004-0252cab4b991",
      "name": "2019 Incentivized Learning Module Catalog",
      "description": "Catalog to group incentivized learning modules in 2019."
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/learning-module-catalogs?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/learning-module-catalogs?offset=0&limit=20"
}

GET /learning-module-catalogs

Retrieves all of the learning module catalogs that can group learning modules.

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

Update a Learning Module Catalog




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/consumer-engagement/v1/learning-module-catalogs/66886ed6-cfde-427c-9384-bc0995dc3a7e', headers: headers, body: {"name":"2019 Incentivized Learning Module Catalog","description":"Catalog to group incentivized learning modules in 2019."}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/learning-module-catalogs/66886ed6-cfde-427c-9384-bc0995dc3a7e \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"2019 Incentivized Learning Module Catalog","description":"Catalog to group incentivized learning modules in 2019."}

PUT /learning-module-catalogs/{catalogId}

Updates information for a learning module catalog that can be used to group learning modules.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
catalogId	path	string	true	N/A	The ID of the catalog.	-
body	body	putLearningModuleCatalogs	true	N/A	No description	-

Response Statuses

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

Retrieve a Learning Module Catalog


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/consumer-engagement/v1/learning-module-catalogs/66886ed6-cfde-427c-9384-bc0995dc3a7e', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/learning-module-catalogs/66886ed6-cfde-427c-9384-bc0995dc3a7e \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

GET /learning-module-catalogs/{catalogId}

Retrieves a learning module catalog based on its ID. This is used to retrieve information for a single learning module catalog.

Parameters

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

Response Statuses

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

Challenges

Challenges are engagement programs that encourage consumers to meet a personal or team-based goal. Challenges can be designed for individual consumers or for groups of consumers to complete together. Wellness programs can use challenges to create social awareness of healthy activities, facilitate competitions, and increase participation in the program, ultimately leading to positive behavior change and improved health outcomes. Additionally, challenge outcomes can be used for challenge leaderboards to compare how a particular consumer performed compared to all the other consumers participating in the challenge.

Create a Challenge




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/consumer-engagement/v1/challenges', headers: headers, body: {"names":[{"text":"Walking Challenge","locale":"en-US"}],"descriptions":[{"text":"90-day challenge to get into shape by walking","locale":"en-US"}],"consumerGroups":[{"id":"0276ea55-a3cc-4b0a-88dc-284629d6"}],"imageURL":"https://cerner.com/download/101/bewell_profile.png","startsAt":"2019-08-13T12:23:12Z","endsAt":"2019-08-30T12:23:12Z","registrationStartsAt":"2019-08-06T12:23:12Z","registrationEndsAt":"2019-08-20T12:23:12Z","timeZone":"America/New_York","catalogs":[{"id":"076295f2-bded-11e9-bed5-2a2ae2dbcce4"}],"goals":[{"id":"0185e5f2-bded-11e9-bed5-2a2ae2dbcce4"}],"completionCriteria":[{"goal":{"id":"74b44ea3-fb6b-4245-886b-caa8e156f125"},"value":100000,"timesGoalMet":1,"interval":"CHALLENGE_DURATION"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/challenges \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"names":[{"text":"Walking Challenge","locale":"en-US"}],"descriptions":[{"text":"90-day challenge to get into shape by walking","locale":"en-US"}],"consumerGroups":[{"id":"0276ea55-a3cc-4b0a-88dc-284629d6"}],"imageURL":"https://cerner.com/download/101/bewell_profile.png","startsAt":"2019-08-13T12:23:12Z","endsAt":"2019-08-30T12:23:12Z","registrationStartsAt":"2019-08-06T12:23:12Z","registrationEndsAt":"2019-08-20T12:23:12Z","timeZone":"America/New_York","catalogs":[{"id":"076295f2-bded-11e9-bed5-2a2ae2dbcce4"}],"goals":[{"id":"0185e5f2-bded-11e9-bed5-2a2ae2dbcce4"}],"completionCriteria":[{"goal":{"id":"74b44ea3-fb6b-4245-886b-caa8e156f125"},"value":100000,"timesGoalMet":1,"interval":"CHALLENGE_DURATION"}]}

{
  "id": "74b44ea3-fb6b-4245-886b-caa8e156f125",
  "names": [
    {
      "locale": "en-US",
      "text": "Walking Challenge"
    }
  ],
  "descriptions": [
    {
      "locale": "en-US",
      "text": "90-day challenge to get into shape by walking"
    }
  ],
  "consumerGroups": [
    {
      "id": "0276ea55-a3cc-4b0a-88dc-284629d6"
    }
  ],
  "imageURL": "https://cerner.com/download/101/bewell_profile.png",
  "startsAt": "2019-08-13T12:23:12Z",
  "endsAt": "2019-08-30T12:23:12Z",
  "registrationStartsAt": "2019-08-06T12:23:12Z",
  "registrationEndsAt": "2019-08-20T12:23:12Z",
  "timeZone": "America/New_York",
  "catalogs": [
    {
      "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
      "names": [
        {
          "locale": "en-US",
          "text": "Kansas City Wellness Challenges"
        }
      ],
      "descriptions": [
        {
          "locale": "en-US",
          "text": "All challenges for the Kansas City location"
        }
      ]
    }
  ],
  "goals": [
    {
      "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
      "names": [
        {
          "locale": "en-US",
          "text": "Complete 150,000 steps in four weeks"
        }
      ],
      "descriptions": [
        {
          "locale": "en-US",
          "text": "Walk 5000 steps every day to meet your goal"
        }
      ],
      "type": "STEPS",
      "value": 100000,
      "unit": "STEPS",
      "frequency": "ONE_TIME",
      "isAffirmative": true,
      "coding": {
        "code": "10831000175105",
        "system": "2.16.840.1.113883.6.96",
        "display": "Steps"
      },
      "createdAt": "2020-06-01T10:00:00.000Z",
      "updatedAt": "2020-06-07T10:00:00.000Z"
    }
  ],
  "completionCriteria": [
    {
      "goal": {
        "id": "74b44ea3-fb6b-4245-886b-caa8e156f125"
      },
      "value": 100000,
      "timesGoalMet": 1,
      "interval": "CHALLENGE_DURATION"
    }
  ],
  "createdAt": "2020-06-01T10:00:00.000Z",
  "updatedAt": "2020-06-07T10:00:00.000Z"
}

POST /challenges

Creates a challenge using the specified parameters. Challenges are engagement programs used to encourage consumers to participate in behaviors specified by the challenge goal or goals. Challenges can be created on an individual or team level. Completion criteria can be used to define what a consumer must do to complete a challenge. For consumers to complete a challenge, they must meet all specified completion criteria.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
201	Created	Created	ConsumerEngagementPublicApi_Entities_V1_Challenges_Challenge
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error

Retrieve a List of Challenges


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/consumer-engagement/v1/challenges', headers: headers)

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "74b44ea3-fb6b-4245-886b-caa8e156f125",
      "names": [
        {
          "locale": "en-US",
          "text": "Walking Challenge"
        }
      ],
      "descriptions": [
        {
          "locale": "en-US",
          "text": "90-day challenge to get into shape by walking"
        }
      ],
      "consumerGroups": [
        {
          "id": "0276ea55-a3cc-4b0a-88dc-284629d6"
        }
      ],
      "imageURL": "https://cerner.com/download/101/bewell_profile.png",
      "startsAt": "2019-08-13T12:23:12Z",
      "endsAt": "2019-08-30T12:23:12Z",
      "registrationStartsAt": "2019-08-06T12:23:12Z",
      "registrationEndsAt": "2019-08-20T12:23:12Z",
      "timeZone": "America/New_York",
      "catalogs": [
        {
          "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
          "names": [
            {
              "locale": "en-US",
              "text": "Kansas City Wellness Challenges"
            }
          ],
          "descriptions": [
            {
              "locale": "en-US",
              "text": "All challenges for the Kansas City location"
            }
          ]
        }
      ],
      "goals": [
        {
          "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
          "names": [
            {
              "locale": "en-US",
              "text": "Complete 150,000 steps in four weeks"
            }
          ],
          "descriptions": [
            {
              "locale": "en-US",
              "text": "Walk 5000 steps every day to meet your goal"
            }
          ],
          "type": "STEPS",
          "value": 100000,
          "unit": "STEPS",
          "frequency": "ONE_TIME",
          "isAffirmative": true,
          "coding": {
            "code": "10831000175105",
            "system": "2.16.840.1.113883.6.96",
            "display": "Steps"
          },
          "createdAt": "2020-06-01T10:00:00.000Z",
          "updatedAt": "2020-06-07T10:00:00.000Z"
        }
      ],
      "completionCriteria": [
        {
          "goal": {
            "id": "74b44ea3-fb6b-4245-886b-caa8e156f125"
          },
          "value": 100000,
          "timesGoalMet": 1,
          "interval": "CHALLENGE_DURATION"
        }
      ],
      "createdAt": "2020-06-01T10:00:00.000Z",
      "updatedAt": "2020-06-07T10:00:00.000Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/challenges?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/challenges?offset=0&limit=20"
}

GET /challenges

Retrieves a list of challenges.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
catalogId	query	array[string]	false	N/A	The ID or IDs of one or more catalogs by which to filter the challenges.	-
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.	-
consumerGroupId	query	array[string]	false	N/A	Filters by the ID of the consumer group.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	Success	Challenges
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error

Delete a Challenge


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/consumer-engagement/v1/challenges/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/consumer-engagement/v1/challenges/1a857d33-5b74-4c76-9a60-a008ea652cc6 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /challenges/{challengeId}

Deletes a single challenge by ID.

Parameters

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

Response Statuses

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

Update a Challenge




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/consumer-engagement/v1/challenges/1a857d33-5b74-4c76-9a60-a008ea652cc6', headers: headers, body: {"names":[{"text":"Walking Challenge","locale":"en-US"}],"descriptions":[{"text":"90-day challenge to get into shape by walking","locale":"en-US"}],"consumerGroups":[{"id":"0276ea55-a3cc-4b0a-88dc-284629d6"}],"imageURL":"https://cerner.com/download/101/bewell_profile.png","startsAt":"2019-08-13T12:23:12Z","endsAt":"2019-08-30T12:23:12Z","registrationStartsAt":"2019-08-06T12:23:12Z","registrationEndsAt":"2019-08-20T12:23:12Z","timeZone":"America/New_York","catalogs":[{"id":"076295f2-bded-11e9-bed5-2a2ae2dbcce4"}],"goals":[{"id":"0185e5f2-bded-11e9-bed5-2a2ae2dbcce4"}],"completionCriteria":[{"goal":{"id":"74b44ea3-fb6b-4245-886b-caa8e156f125"},"value":100000,"timesGoalMet":1,"interval":"CHALLENGE_DURATION"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/challenges/1a857d33-5b74-4c76-9a60-a008ea652cc6 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"names":[{"text":"Walking Challenge","locale":"en-US"}],"descriptions":[{"text":"90-day challenge to get into shape by walking","locale":"en-US"}],"consumerGroups":[{"id":"0276ea55-a3cc-4b0a-88dc-284629d6"}],"imageURL":"https://cerner.com/download/101/bewell_profile.png","startsAt":"2019-08-13T12:23:12Z","endsAt":"2019-08-30T12:23:12Z","registrationStartsAt":"2019-08-06T12:23:12Z","registrationEndsAt":"2019-08-20T12:23:12Z","timeZone":"America/New_York","catalogs":[{"id":"076295f2-bded-11e9-bed5-2a2ae2dbcce4"}],"goals":[{"id":"0185e5f2-bded-11e9-bed5-2a2ae2dbcce4"}],"completionCriteria":[{"goal":{"id":"74b44ea3-fb6b-4245-886b-caa8e156f125"},"value":100000,"timesGoalMet":1,"interval":"CHALLENGE_DURATION"}]}

PUT /challenges/{challengeId}

Updates a single challenge by ID.

Parameters

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

Response Statuses

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

Retrieve a Single Challenge


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/consumer-engagement/v1/challenges/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/consumer-engagement/v1/challenges/1a857d33-5b74-4c76-9a60-a008ea652cc6 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "74b44ea3-fb6b-4245-886b-caa8e156f125",
  "names": [
    {
      "locale": "en-US",
      "text": "Walking Challenge"
    }
  ],
  "descriptions": [
    {
      "locale": "en-US",
      "text": "90-day challenge to get into shape by walking"
    }
  ],
  "consumerGroups": [
    {
      "id": "0276ea55-a3cc-4b0a-88dc-284629d6"
    }
  ],
  "imageURL": "https://cerner.com/download/101/bewell_profile.png",
  "startsAt": "2019-08-13T12:23:12Z",
  "endsAt": "2019-08-30T12:23:12Z",
  "registrationStartsAt": "2019-08-06T12:23:12Z",
  "registrationEndsAt": "2019-08-20T12:23:12Z",
  "timeZone": "America/New_York",
  "catalogs": [
    {
      "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
      "names": [
        {
          "locale": "en-US",
          "text": "Kansas City Wellness Challenges"
        }
      ],
      "descriptions": [
        {
          "locale": "en-US",
          "text": "All challenges for the Kansas City location"
        }
      ]
    }
  ],
  "goals": [
    {
      "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
      "names": [
        {
          "locale": "en-US",
          "text": "Complete 150,000 steps in four weeks"
        }
      ],
      "descriptions": [
        {
          "locale": "en-US",
          "text": "Walk 5000 steps every day to meet your goal"
        }
      ],
      "type": "STEPS",
      "value": 100000,
      "unit": "STEPS",
      "frequency": "ONE_TIME",
      "isAffirmative": true,
      "coding": {
        "code": "10831000175105",
        "system": "2.16.840.1.113883.6.96",
        "display": "Steps"
      },
      "createdAt": "2020-06-01T10:00:00.000Z",
      "updatedAt": "2020-06-07T10:00:00.000Z"
    }
  ],
  "completionCriteria": [
    {
      "goal": {
        "id": "74b44ea3-fb6b-4245-886b-caa8e156f125"
      },
      "value": 100000,
      "timesGoalMet": 1,
      "interval": "CHALLENGE_DURATION"
    }
  ],
  "createdAt": "2020-06-01T10:00:00.000Z",
  "updatedAt": "2020-06-07T10:00:00.000Z"
}

GET /challenges/{challengeId}

Retrieves a single challenge by ID.

Parameters

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

Response Statuses

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

Create a Team Challenge




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/consumer-engagement/v1/team-challenges', headers: headers, body: {"names":[{"text":"Walking Challenge","locale":"en-US"}],"descriptions":[{"text":"90-day challenge to get into shape by walking","locale":"en-US"}],"consumerGroups":[{"id":"0276ea55-a3cc-4b0a-88dc-284629d6"}],"imageURL":"https://cerner.com/download/101/bewell_profile.png","startsAt":"2019-08-13T12:23:12Z","endsAt":"2019-08-30T12:23:12Z","registrationStartsAt":"2019-08-06T12:23:12Z","registrationEndsAt":"2019-08-20T12:23:12Z","canConsumerCreateTeam":true,"timeZone":"America/New_York","maxTeamRegistrations":50,"catalogs":[{"id":"076295f2-bded-11e9-bed5-2a2ae2dbcce4"}],"goals":[{"id":"0185e5f2-bded-11e9-bed5-2a2ae2dbcce4"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/team-challenges \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"names":[{"text":"Walking Challenge","locale":"en-US"}],"descriptions":[{"text":"90-day challenge to get into shape by walking","locale":"en-US"}],"consumerGroups":[{"id":"0276ea55-a3cc-4b0a-88dc-284629d6"}],"imageURL":"https://cerner.com/download/101/bewell_profile.png","startsAt":"2019-08-13T12:23:12Z","endsAt":"2019-08-30T12:23:12Z","registrationStartsAt":"2019-08-06T12:23:12Z","registrationEndsAt":"2019-08-20T12:23:12Z","canConsumerCreateTeam":true,"timeZone":"America/New_York","maxTeamRegistrations":50,"catalogs":[{"id":"076295f2-bded-11e9-bed5-2a2ae2dbcce4"}],"goals":[{"id":"0185e5f2-bded-11e9-bed5-2a2ae2dbcce4"}]}

{
  "id": "74b44ea3-fb6b-4245-886b-caa8e156f125",
  "names": [
    {
      "locale": "en-US",
      "text": "Walking Challenge"
    }
  ],
  "descriptions": [
    {
      "locale": "en-US",
      "text": "90-day challenge to get into shape by walking"
    }
  ],
  "consumerGroups": [
    {
      "id": "0276ea55-a3cc-4b0a-88dc-284629d6"
    }
  ],
  "imageURL": "https://cerner.com/download/101/bewell_profile.png",
  "startsAt": "2019-08-13T12:23:12Z",
  "endsAt": "2019-08-30T12:23:12Z",
  "registrationStartsAt": "2019-08-06T12:23:12Z",
  "registrationEndsAt": "2019-08-20T12:23:12Z",
  "canConsumerCreateTeam": true,
  "timeZone": "America/New_York",
  "maxTeamRegistrations": 50,
  "catalogs": [
    {
      "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
      "names": [
        {
          "locale": "en-US",
          "text": "Kansas City Wellness Challenges"
        }
      ],
      "descriptions": [
        {
          "locale": "en-US",
          "text": "All challenges for the Kansas City location"
        }
      ]
    }
  ],
  "goals": [
    {
      "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
      "names": [
        {
          "locale": "en-US",
          "text": "Complete 150,000 steps in four weeks"
        }
      ],
      "descriptions": [
        {
          "locale": "en-US",
          "text": "Walk 5000 steps every day to meet your goal"
        }
      ],
      "type": "STEPS",
      "value": 100000,
      "unit": "STEPS",
      "frequency": "ONE_TIME",
      "isAffirmative": true,
      "coding": {
        "code": "10831000175105",
        "system": "2.16.840.1.113883.6.96",
        "display": "Steps"
      },
      "createdAt": "2020-06-01T10:00:00.000Z",
      "updatedAt": "2020-06-07T10:00:00.000Z"
    }
  ],
  "createdAt": "2020-06-01T10:00:00.000Z",
  "updatedAt": "2020-06-07T10:00:00.000Z"
}

POST /team-challenges

Creates a team challenge using the specified parameters.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
201	Created	Created	ConsumerEngagementPublicApi_Entities_V1_Challenges_TeamChallenge
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error

Retrieve a List of Team Challenges


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/consumer-engagement/v1/team-challenges', headers: headers)

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "74b44ea3-fb6b-4245-886b-caa8e156f125",
      "names": [
        {
          "locale": "en-US",
          "text": "Walking Challenge"
        }
      ],
      "descriptions": [
        {
          "locale": "en-US",
          "text": "90-day challenge to get into shape by walking"
        }
      ],
      "consumerGroups": [
        {
          "id": "0276ea55-a3cc-4b0a-88dc-284629d6"
        }
      ],
      "imageURL": "https://cerner.com/download/101/bewell_profile.png",
      "startsAt": "2019-08-13T12:23:12Z",
      "endsAt": "2019-08-30T12:23:12Z",
      "registrationStartsAt": "2019-08-06T12:23:12Z",
      "registrationEndsAt": "2019-08-20T12:23:12Z",
      "canConsumerCreateTeam": true,
      "timeZone": "America/New_York",
      "maxTeamRegistrations": 50,
      "catalogs": [
        {
          "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
          "names": [
            {
              "locale": "en-US",
              "text": "Kansas City Wellness Challenges"
            }
          ],
          "descriptions": [
            {
              "locale": "en-US",
              "text": "All challenges for the Kansas City location"
            }
          ]
        }
      ],
      "goals": [
        {
          "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
          "names": [
            {
              "locale": "en-US",
              "text": "Complete 150,000 steps in four weeks"
            }
          ],
          "descriptions": [
            {
              "locale": "en-US",
              "text": "Walk 5000 steps every day to meet your goal"
            }
          ],
          "type": "STEPS",
          "value": 100000,
          "unit": "STEPS",
          "frequency": "ONE_TIME",
          "isAffirmative": true,
          "coding": {
            "code": "10831000175105",
            "system": "2.16.840.1.113883.6.96",
            "display": "Steps"
          },
          "createdAt": "2020-06-01T10:00:00.000Z",
          "updatedAt": "2020-06-07T10:00:00.000Z"
        }
      ],
      "createdAt": "2020-06-01T10:00:00.000Z",
      "updatedAt": "2020-06-07T10:00:00.000Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/team-challenges?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/team-challenges?offset=0&limit=20"
}

GET /team-challenges

Retrieves a list of team challenges.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
catalogId	query	array[string]	false	N/A	The ID or IDs of one or more catalogs by which to filter the challenges.	-
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.	-
consumerGroupId	query	array[string]	false	N/A	Filters by the ID of the consumer group.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	Success	TeamChallenges
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error

Delete a Team Challenge


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/consumer-engagement/v1/team-challenges/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/consumer-engagement/v1/team-challenges/1a857d33-5b74-4c76-9a60-a008ea652cc6 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /team-challenges/{teamChallengeId}

Deletes a single team challenge by ID.

Parameters

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

Response Statuses

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

Update a Team Challenge




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/consumer-engagement/v1/team-challenges/1a857d33-5b74-4c76-9a60-a008ea652cc6', headers: headers, body: {"names":[{"text":"Walking Challenge","locale":"en-US"}],"descriptions":[{"text":"90-day challenge to get into shape by walking","locale":"en-US"}],"consumerGroups":[{"id":"0276ea55-a3cc-4b0a-88dc-284629d6"}],"imageURL":"https://cerner.com/download/101/bewell_profile.png","startsAt":"2019-08-13T12:23:12Z","endsAt":"2019-08-30T12:23:12Z","registrationStartsAt":"2019-08-06T12:23:12Z","registrationEndsAt":"2019-08-20T12:23:12Z","canConsumerCreateTeam":true,"timeZone":"America/New_York","maxTeamRegistrations":50,"catalogs":[{"id":"076295f2-bded-11e9-bed5-2a2ae2dbcce4"}],"goals":[{"id":"0185e5f2-bded-11e9-bed5-2a2ae2dbcce4"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/team-challenges/1a857d33-5b74-4c76-9a60-a008ea652cc6 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"names":[{"text":"Walking Challenge","locale":"en-US"}],"descriptions":[{"text":"90-day challenge to get into shape by walking","locale":"en-US"}],"consumerGroups":[{"id":"0276ea55-a3cc-4b0a-88dc-284629d6"}],"imageURL":"https://cerner.com/download/101/bewell_profile.png","startsAt":"2019-08-13T12:23:12Z","endsAt":"2019-08-30T12:23:12Z","registrationStartsAt":"2019-08-06T12:23:12Z","registrationEndsAt":"2019-08-20T12:23:12Z","canConsumerCreateTeam":true,"timeZone":"America/New_York","maxTeamRegistrations":50,"catalogs":[{"id":"076295f2-bded-11e9-bed5-2a2ae2dbcce4"}],"goals":[{"id":"0185e5f2-bded-11e9-bed5-2a2ae2dbcce4"}]}

PUT /team-challenges/{teamChallengeId}

Updates a single team challenge by ID.

Parameters

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

Response Statuses

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

Retrieve a Single Team Challenge


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/consumer-engagement/v1/team-challenges/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/consumer-engagement/v1/team-challenges/1a857d33-5b74-4c76-9a60-a008ea652cc6 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "74b44ea3-fb6b-4245-886b-caa8e156f125",
  "names": [
    {
      "locale": "en-US",
      "text": "Walking Challenge"
    }
  ],
  "descriptions": [
    {
      "locale": "en-US",
      "text": "90-day challenge to get into shape by walking"
    }
  ],
  "consumerGroups": [
    {
      "id": "0276ea55-a3cc-4b0a-88dc-284629d6"
    }
  ],
  "imageURL": "https://cerner.com/download/101/bewell_profile.png",
  "startsAt": "2019-08-13T12:23:12Z",
  "endsAt": "2019-08-30T12:23:12Z",
  "registrationStartsAt": "2019-08-06T12:23:12Z",
  "registrationEndsAt": "2019-08-20T12:23:12Z",
  "canConsumerCreateTeam": true,
  "timeZone": "America/New_York",
  "maxTeamRegistrations": 50,
  "catalogs": [
    {
      "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
      "names": [
        {
          "locale": "en-US",
          "text": "Kansas City Wellness Challenges"
        }
      ],
      "descriptions": [
        {
          "locale": "en-US",
          "text": "All challenges for the Kansas City location"
        }
      ]
    }
  ],
  "goals": [
    {
      "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
      "names": [
        {
          "locale": "en-US",
          "text": "Complete 150,000 steps in four weeks"
        }
      ],
      "descriptions": [
        {
          "locale": "en-US",
          "text": "Walk 5000 steps every day to meet your goal"
        }
      ],
      "type": "STEPS",
      "value": 100000,
      "unit": "STEPS",
      "frequency": "ONE_TIME",
      "isAffirmative": true,
      "coding": {
        "code": "10831000175105",
        "system": "2.16.840.1.113883.6.96",
        "display": "Steps"
      },
      "createdAt": "2020-06-01T10:00:00.000Z",
      "updatedAt": "2020-06-07T10:00:00.000Z"
    }
  ],
  "createdAt": "2020-06-01T10:00:00.000Z",
  "updatedAt": "2020-06-07T10:00:00.000Z"
}

GET /team-challenges/{teamChallengeId}

Retrieves a single team challenge by ID.

Parameters

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

Response Statuses

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

Create a Team Definition




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/team-definitions', headers: headers, body: {"teamChallengeId":"b95218d0-470f-11ea-b77f-2e728ce88125","name":"Fitness Squad","description":"Join the Fitness Squad and stay motivated to compete with other teams and win this challenge.","imageUrl":"https://cerner.com/download/101/bewell_profile.png","createdBy":{"id":"f078eb81-1a74-4418-87e2-40a6ddab490c","kind":"CONSUMER"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/team-definitions \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"teamChallengeId":"b95218d0-470f-11ea-b77f-2e728ce88125","name":"Fitness Squad","description":"Join the Fitness Squad and stay motivated to compete with other teams and win this challenge.","imageUrl":"https://cerner.com/download/101/bewell_profile.png","createdBy":{"id":"f078eb81-1a74-4418-87e2-40a6ddab490c","kind":"CONSUMER"}}

{
  "id": "74b44ea3-fb6b-4245-886b-caa8e156f125",
  "teamChallengeId": "b95218d0-470f-11ea-b77f-2e728ce88125",
  "name": "Fitness Squad",
  "description": "Join the Fitness Squad and stay motivated to compete with other teams and win this challenge.",
  "imageURL": "https://cerner.com/download/101/bewell_profile.png",
  "availableRegistrations": 5,
  "createdBy": {
    "id": "f078eb81-1a74-4418-87e2-40a6ddab490c",
    "kind": "CONSUMER"
  },
  "createdAt": "2020-06-01T10:00:00.000Z",
  "updatedAt": "2020-06-07T10:00:00.000Z"
}

POST /team-definitions

Creates a team definition using the specified parameters. A team can be created by either consumers participating in the challenge or an administrator.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
201	Created	Created	ConsumerEngagementPublicApi_Entities_V1_Challenges_TeamDefinition
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error

Retrieve a List of Team Definitions


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/team-definitions', headers: headers)

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "74b44ea3-fb6b-4245-886b-caa8e156f125",
      "teamChallengeId": "b95218d0-470f-11ea-b77f-2e728ce88125",
      "name": "Fitness Squad",
      "description": "Join the Fitness Squad and stay motivated to compete with other teams and win this challenge.",
      "imageURL": "https://cerner.com/download/101/bewell_profile.png",
      "availableRegistrations": 5,
      "createdBy": {
        "id": "f078eb81-1a74-4418-87e2-40a6ddab490c",
        "kind": "CONSUMER"
      },
      "createdAt": "2020-06-01T10:00:00.000Z",
      "updatedAt": "2020-06-07T10:00:00.000Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/team-definitions?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/team-definitions?offset=0&limit=20"
}

GET /team-definitions

Retrieves a list of team definitions.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
teamChallengeId	query	array[string]	false	N/A	The ID or IDs of one or more team challenges by which to filter the team registrations.	-
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	TeamDefinitions
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error

Delete a Team Definition


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/consumer-engagement/v1/team-definitions/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/consumer-engagement/v1/team-definitions/1a857d33-5b74-4c76-9a60-a008ea652cc6 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /team-definitions/{teamDefinitionId}

Deletes a single team definition by ID. This operation also deletes team challenge outcomes, team outcomes, team availabilities, and team registrations for the team. Deleting a team definition when the team challenge is in progress affects the team challenge outcome because the team’s contribution is removed from the outcome.

Parameters

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

Response Statuses

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

Update a Team Definition




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

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

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/team-definitions/1a857d33-5b74-4c76-9a60-a008ea652cc6', headers: headers, body: {"teamChallengeId":"b95218d0-470f-11ea-b77f-2e728ce88125","name":"Fitness Squad","description":"Join the Fitness Squad and stay motivated to compete with other teams and win this challenge.","imageUrl":"https://cerner.com/download/101/bewell_profile.png","createdBy":{"id":"f078eb81-1a74-4418-87e2-40a6ddab490c","kind":"CONSUMER"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/team-definitions/1a857d33-5b74-4c76-9a60-a008ea652cc6 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"teamChallengeId":"b95218d0-470f-11ea-b77f-2e728ce88125","name":"Fitness Squad","description":"Join the Fitness Squad and stay motivated to compete with other teams and win this challenge.","imageUrl":"https://cerner.com/download/101/bewell_profile.png","createdBy":{"id":"f078eb81-1a74-4418-87e2-40a6ddab490c","kind":"CONSUMER"}}

PUT /team-definitions/{teamDefinitionId}

Update a single team definition by ID.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
teamDefinitionId	path	string	true	N/A	The ID of the team definition.	-
body	body	putTeamDefinitions	true	N/A	No description	-

Response Statuses

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

Retrieve a Single Team Definition


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/team-definitions/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/consumer-engagement/v1/team-definitions/1a857d33-5b74-4c76-9a60-a008ea652cc6 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "74b44ea3-fb6b-4245-886b-caa8e156f125",
  "teamChallengeId": "b95218d0-470f-11ea-b77f-2e728ce88125",
  "name": "Fitness Squad",
  "description": "Join the Fitness Squad and stay motivated to compete with other teams and win this challenge.",
  "imageURL": "https://cerner.com/download/101/bewell_profile.png",
  "availableRegistrations": 5,
  "createdBy": {
    "id": "f078eb81-1a74-4418-87e2-40a6ddab490c",
    "kind": "CONSUMER"
  },
  "createdAt": "2020-06-01T10:00:00.000Z",
  "updatedAt": "2020-06-07T10:00:00.000Z"
}

GET /team-definitions/{teamDefinitionId}

Retrieves a single team definition by ID.

Parameters

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

Response Statuses

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

Create a Team Registration




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/consumer-engagement/v1/team-registrations', headers: headers, body: {"teamChallengeId":"b95218d0-470f-11ea-b77f-2e728ce88125","teamId":"6c235b5a-470f-11ea-b77f-2e728ce88125","consumerId":"b491d16e-470f-11ea-b77f-2e728ce88125"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/team-registrations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"teamChallengeId":"b95218d0-470f-11ea-b77f-2e728ce88125","teamId":"6c235b5a-470f-11ea-b77f-2e728ce88125","consumerId":"b491d16e-470f-11ea-b77f-2e728ce88125"}

{
  "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
  "teamChallengeId": "7159c778-470d-11ea-b77f-2e728ce88125",
  "teamId": "8034293c-470d-11ea-b77f-2e728ce88125",
  "consumerId": "86b87178-470d-11ea-b77f-2e728ce88125",
  "createdAt": "2020-06-01T10:00:00.000Z",
  "updatedAt": "2020-06-07T10:00:00.000Z"
}

POST /team-registrations

Creates a team registration using the specified parameters. Consumers can register to be in a team only if the team has registrations available and registration is still open for the team challenge.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
201	Created	Created	ConsumerEngagementPublicApi_Entities_V1_Challenges_TeamRegistration
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error

Retrieve a List of Team Registrations


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/consumer-engagement/v1/team-registrations', headers: headers)

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
      "teamChallengeId": "7159c778-470d-11ea-b77f-2e728ce88125",
      "teamId": "8034293c-470d-11ea-b77f-2e728ce88125",
      "consumerId": "86b87178-470d-11ea-b77f-2e728ce88125",
      "createdAt": "2020-06-01T10:00:00.000Z",
      "updatedAt": "2020-06-07T10:00:00.000Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/team-registrations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/team-registrations?offset=0&limit=20"
}

GET /team-registrations

Retrieves a list of team registrations.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
consumerId	query	array[string]	false	N/A	The ID or IDs of one or more consumers whose team registrations are to be retrieved.	-
teamChallengeId	query	array[string]	false	N/A	The ID or IDs of one or more team challenges by which to filter the team registrations.	-
teamId	query	array[string]	false	N/A	The ID of the team.	-
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	TeamRegistrations
401	Unauthorized	Unauthorized	Error

Delete a Team Registration


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/consumer-engagement/v1/team-registrations/11e8902c9e2908c69718f13503066bee', headers: headers)

print JSON.pretty_generate(result)


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

DELETE /team-registrations/{teamRegistrationId}

Deletes a single team registration for a consumer by ID. Deleting a registration while the challenge is in progress removes the consumer’s contribution and changes the team’s total.

Parameters

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

Response Statuses

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

Retrieve a Single Team Registration


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/consumer-engagement/v1/team-registrations/11e8902c9e2908c69718f13503066bee', headers: headers)

print JSON.pretty_generate(result)


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

{
  "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
  "teamChallengeId": "7159c778-470d-11ea-b77f-2e728ce88125",
  "teamId": "8034293c-470d-11ea-b77f-2e728ce88125",
  "consumerId": "86b87178-470d-11ea-b77f-2e728ce88125",
  "createdAt": "2020-06-01T10:00:00.000Z",
  "updatedAt": "2020-06-07T10:00:00.000Z"
}

GET /team-registrations/{teamRegistrationId}

Retrieves a single team registration by ID.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
200	OK	Success	ConsumerEngagementPublicApi_Entities_V1_Challenges_TeamRegistration
401	Unauthorized	Unauthorized	Error
404	Not Found	Not Found	Error

Create a Challenge Goal




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/challenge-goals', headers: headers, body: {"names":[{"text":"Complete 150,000 steps in four weeks","locale":"en-US"}],"descriptions":[{"text":"Walk 5000 steps every day to meet your goal","locale":"en-US"}],"type":"STEPS","value":100000,"unit":"STEPS","frequency":"ONE_TIME","isAffirmative":true,"coding":{"code":"10831000175105","system":"2.16.840.1.113883.6.96","display":"Steps"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/challenge-goals \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"names":[{"text":"Complete 150,000 steps in four weeks","locale":"en-US"}],"descriptions":[{"text":"Walk 5000 steps every day to meet your goal","locale":"en-US"}],"type":"STEPS","value":100000,"unit":"STEPS","frequency":"ONE_TIME","isAffirmative":true,"coding":{"code":"10831000175105","system":"2.16.840.1.113883.6.96","display":"Steps"}}

{
  "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
  "names": [
    {
      "locale": "en-US",
      "text": "Complete 150,000 steps in four weeks"
    }
  ],
  "descriptions": [
    {
      "locale": "en-US",
      "text": "Walk 5000 steps every day to meet your goal"
    }
  ],
  "type": "STEPS",
  "value": 100000,
  "unit": "STEPS",
  "frequency": "ONE_TIME",
  "isAffirmative": true,
  "coding": {
    "code": "10831000175105",
    "system": "2.16.840.1.113883.6.96",
    "display": "Steps"
  },
  "createdAt": "2020-06-01T10:00:00.000Z",
  "updatedAt": "2020-06-07T10:00:00.000Z"
}

POST /challenge-goals

Creates a challenge goal using the specified parameters. A goal linked to an individual challenge is complete when the consumer reaches the value of the goal within the specified frequency. A goal can have a daily, weekly, or one time frequency. Goals with a one time frequency must be completed within the start and end dates of the challenge. Goals with a null value and unit are tracked by consumers affirming they completed the goal. A goal linked to a team-based challenge is complete when the team total reaches the value of the goal within the duration of the team challenge.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
201	Created	Created	ConsumerEngagementPublicApi_Entities_V1_Challenges_Goal
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error

Retrieve a List of Challenge Goals


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/consumer-engagement/v1/challenge-goals', headers: headers)

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
      "names": [
        {
          "locale": "en-US",
          "text": "Complete 150,000 steps in four weeks"
        }
      ],
      "descriptions": [
        {
          "locale": "en-US",
          "text": "Walk 5000 steps every day to meet your goal"
        }
      ],
      "type": "STEPS",
      "value": 100000,
      "unit": "STEPS",
      "frequency": "ONE_TIME",
      "isAffirmative": true,
      "coding": {
        "code": "10831000175105",
        "system": "2.16.840.1.113883.6.96",
        "display": "Steps"
      },
      "createdAt": "2020-06-01T10:00:00.000Z",
      "updatedAt": "2020-06-07T10:00:00.000Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/challenge-goals?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/challenge-goals?offset=0&limit=20"
}

GET /challenge-goals

Retrieves a list of challenge goals.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
type	query	array[string]	false	N/A	One or more challenge goal types by which to filter results.	-
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	Goals
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error

Delete a Challenge Goal


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/challenge-goals/873ed54e-d4e5-44ed-a2ca-0dac7f858646', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/challenge-goals/873ed54e-d4e5-44ed-a2ca-0dac7f858646 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /challenge-goals/{goalId}

Deletes a single challenge goal by ID.

Parameters

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

Response Statuses

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

Update a Challenge Goal




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/consumer-engagement/v1/challenge-goals/1a857d33-5b74-4c76-9a60-a008ea652cc6', headers: headers, body: {"names":[{"text":"Complete 150,000 steps in four weeks","locale":"en-US"}],"descriptions":[{"text":"Walk 5000 steps every day to meet your goal","locale":"en-US"}],"type":"STEPS","value":100000,"unit":"STEPS","frequency":"ONE_TIME","isAffirmative":true,"coding":{"code":"10831000175105","system":"2.16.840.1.113883.6.96","display":"Steps"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/challenge-goals/1a857d33-5b74-4c76-9a60-a008ea652cc6 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"names":[{"text":"Complete 150,000 steps in four weeks","locale":"en-US"}],"descriptions":[{"text":"Walk 5000 steps every day to meet your goal","locale":"en-US"}],"type":"STEPS","value":100000,"unit":"STEPS","frequency":"ONE_TIME","isAffirmative":true,"coding":{"code":"10831000175105","system":"2.16.840.1.113883.6.96","display":"Steps"}}

PUT /challenge-goals/{goalId}

Updates a challenge goal by ID.

Parameters

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

Response Statuses

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

Retrieve a Single Challenge Goal


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/challenge-goals/873ed54e-d4e5-44ed-a2ca-0dac7f858646', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/challenge-goals/873ed54e-d4e5-44ed-a2ca-0dac7f858646 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
  "names": [
    {
      "locale": "en-US",
      "text": "Complete 150,000 steps in four weeks"
    }
  ],
  "descriptions": [
    {
      "locale": "en-US",
      "text": "Walk 5000 steps every day to meet your goal"
    }
  ],
  "type": "STEPS",
  "value": 100000,
  "unit": "STEPS",
  "frequency": "ONE_TIME",
  "isAffirmative": true,
  "coding": {
    "code": "10831000175105",
    "system": "2.16.840.1.113883.6.96",
    "display": "Steps"
  },
  "createdAt": "2020-06-01T10:00:00.000Z",
  "updatedAt": "2020-06-07T10:00:00.000Z"
}

GET /challenge-goals/{goalId}

Retrieves a single challenge goal by ID.

Parameters

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

Response Statuses

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

Create a Challenge Catalog




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/consumer-engagement/v1/challenge-catalogs', headers: headers)

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/challenge-catalogs \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'

{
  "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
  "names": [
    {
      "locale": "en-US",
      "text": "Kansas City Wellness Challenges"
    }
  ],
  "descriptions": [
    {
      "locale": "en-US",
      "text": "All challenges for the Kansas City location"
    }
  ]
}

POST /challenge-catalogs

Creates a challenge catalog using the specified parameters. A catalog provides a way to group and organize challenges together.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
201	Created	Created	ConsumerEngagementPublicApi_Entities_V1_Challenges_Catalog
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error

Retrieve a List of Challenge Catalogs


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/consumer-engagement/v1/challenge-catalogs', headers: headers)

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
      "names": [
        {
          "locale": "en-US",
          "text": "Kansas City Wellness Challenges"
        }
      ],
      "descriptions": [
        {
          "locale": "en-US",
          "text": "All challenges for the Kansas City location"
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/challenge-catalogs?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/challenge-catalogs?offset=0&limit=20"
}

GET /challenge-catalogs

Retrieves a list of challenge catalogs.

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	Catalogs
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error

Updates a Challenge Catalog




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/consumer-engagement/v1/challenge-catalogs/66886ed6-cfde-427c-9384-bc0995dc3a7e', headers: headers)

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/challenge-catalogs/66886ed6-cfde-427c-9384-bc0995dc3a7e \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'

PUT /challenge-catalogs/{catalogId}

Updates a specific challenge catalog using the provided parameters.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
204	No Content	Updated	ConsumerEngagementPublicApi_Entities_V1_Challenges_Catalog
401	Unauthorized	Unauthorized	Error
404	Not Found	Not Found	Error

Delete a Challenge Catalog


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/consumer-engagement/v1/challenge-catalogs/66886ed6-cfde-427c-9384-bc0995dc3a7e', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/challenge-catalogs/66886ed6-cfde-427c-9384-bc0995dc3a7e \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /challenge-catalogs/{catalogId}

Deletes a single challenge catalog by ID.

Parameters

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

Response Statuses

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

Retrieve a Single Challenge Catalog


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/consumer-engagement/v1/challenge-catalogs/66886ed6-cfde-427c-9384-bc0995dc3a7e', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/challenge-catalogs/66886ed6-cfde-427c-9384-bc0995dc3a7e \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
  "names": [
    {
      "locale": "en-US",
      "text": "Kansas City Wellness Challenges"
    }
  ],
  "descriptions": [
    {
      "locale": "en-US",
      "text": "All challenges for the Kansas City location"
    }
  ]
}

GET /challenge-catalogs/{catalogId}

Retrieves a single challenge catalog by ID.

Parameters

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

Response Statuses

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

Create a Challenge Registration




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/consumer-engagement/v1/challenge-registrations', headers: headers, body: {"challengeId":"94b44ea3-fb6b-4245-886b-caa8e156f125","consumerId":"94b44ea3-fb6b-4245-886b-caa8e156f125","status":"ACTIVE"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/challenge-registrations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"challengeId":"94b44ea3-fb6b-4245-886b-caa8e156f125","consumerId":"94b44ea3-fb6b-4245-886b-caa8e156f125","status":"ACTIVE"}

{
  "id": "90d80434-470d-11ea-b77f-2e728ce88125",
  "challengeId": "977022b8-470d-11ea-b77f-2e728ce88125",
  "consumerId": "a045032c-470d-11ea-b77f-2e728ce88125",
  "status": "ACTIVE",
  "createdAt": "2020-06-01T10:00:00.000Z",
  "updatedAt": "2020-06-07T10:00:00.000Z"
}

POST /challenge-registrations

Creates a challenge registration using the specified parameters. If you created a team challenge, use the team-registrations resource to register consumers in a team.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
201	Created	Created	ConsumerEngagementPublicApi_Entities_V1_Challenges_ChallengeRegistration
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error

Retrieve a List of Challenge Registrations


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/consumer-engagement/v1/challenge-registrations', headers: headers)

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "90d80434-470d-11ea-b77f-2e728ce88125",
      "challengeId": "977022b8-470d-11ea-b77f-2e728ce88125",
      "consumerId": "a045032c-470d-11ea-b77f-2e728ce88125",
      "status": "ACTIVE",
      "createdAt": "2020-06-01T10:00:00.000Z",
      "updatedAt": "2020-06-07T10:00:00.000Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/registrations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/registrations?offset=0&limit=20"
}

GET /challenge-registrations

Retrieves a list of challenge registrations.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
consumerId	query	array[string]	false	N/A	The ID or IDs of one or more consumers whose challenge registrations are to be retrieved.	-
challengeId	query	array[string]	false	N/A	The ID or IDs of one or more challenges by which to filter the challenge registrations.	-
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	ChallengeRegistrations
401	Unauthorized	Unauthorized	Error

Delete a Challenge Registration


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/consumer-engagement/v1/challenge-registrations/11e8902c9e2908c69718f13503066bee', headers: headers)

print JSON.pretty_generate(result)


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

DELETE /challenge-registrations/{registrationId}

Deletes a single challenge registration of a consumer by ID. Deleting a registration while the challenge is in progress also removes the challenge outcome for that consumer.

Parameters

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

Response Statuses

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

Retrieve a Single Challenge Registration


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/consumer-engagement/v1/challenge-registrations/11e8902c9e2908c69718f13503066bee', headers: headers)

print JSON.pretty_generate(result)


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

{
  "id": "90d80434-470d-11ea-b77f-2e728ce88125",
  "challengeId": "977022b8-470d-11ea-b77f-2e728ce88125",
  "consumerId": "a045032c-470d-11ea-b77f-2e728ce88125",
  "status": "ACTIVE",
  "createdAt": "2020-06-01T10:00:00.000Z",
  "updatedAt": "2020-06-07T10:00:00.000Z"
}

GET /challenge-registrations/{registrationId}

Retrieves a single challenge registration by ID.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
200	OK	Success	ConsumerEngagementPublicApi_Entities_V1_Challenges_ChallengeRegistration
401	Unauthorized	Unauthorized	Error
404	Not Found	Not Found	Error

Create a Challenge Outcome




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/consumer-engagement/v1/challenge-outcomes', headers: headers, body: {"challengeId":"b95218d0-470f-11ea-b77f-2e728ce88125","consumerId":"b491d16e-470f-11ea-b77f-2e728ce88125","total":10000}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/challenge-outcomes \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"challengeId":"b95218d0-470f-11ea-b77f-2e728ce88125","consumerId":"b491d16e-470f-11ea-b77f-2e728ce88125","total":10000}

{
  "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
  "challengeId": "977022b8-470d-11ea-b77f-2e728ce88125",
  "consumerId": "86b87178-470d-11ea-b77f-2e728ce88125",
  "total": 10000,
  "rank": 5,
  "status": "COMPLETE",
  "unit": "STEPS",
  "updatedAt": "2018-12-15T12:23:12Z"
}

POST /challenge-outcomes

Creates an outcome for the consumer in the challenge using the specified data. The total is used to calculate the rank of a consumer compared to totals from other consumers in the challenge.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
201	Created	Created	ConsumerEngagementPublicApi_Entities_V1_Challenges_ChallengeOutcome
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
409	Conflict	Conflict	Error

Retrieve a List of Challenge Outcomes


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/consumer-engagement/v1/challenge-outcomes', headers: headers)

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
      "challengeId": "977022b8-470d-11ea-b77f-2e728ce88125",
      "consumerId": "86b87178-470d-11ea-b77f-2e728ce88125",
      "total": 10000,
      "rank": 5,
      "status": "COMPLETE",
      "unit": "STEPS",
      "updatedAt": "2018-12-15T12:23:12Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/challenge-outcomes?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/challenge-outcomes?offset=0&limit=20"
}

GET /challenge-outcomes

Retrieves a list of challenge outcomes. Outcomes by default are sorted by rank. Outcomes can be used for challenge leaderboards to compare how a particular consumer performed compared to all the other consumers participating in the challenge.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
consumerId	query	string	false	N/A	Filters the challenge outcomes by consumer ID.	-
challengeId	query	string	false	N/A	Filters the challenge outcomes by challenge ID.	-
status	query	string	false	N/A	Filters the challenge outcomes by the completion status of a consumer for the challenge. The status is based on whether the challenge goal is met. Possible status values are COMPLETE or INCOMPLETE.	-
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	ChallengeOutcomes
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error

Delete a Challenge Outcome


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/consumer-engagement/v1/challenge-outcomes/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/consumer-engagement/v1/challenge-outcomes/1a857d33-5b74-4c76-9a60-a008ea652cc6 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /challenge-outcomes/{challengeOutcomeId}

Deletes a single challenge outcome by ID. Deleting a challenge outcome does not immediately update the overall rankings.

Parameters

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

Response Statuses

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

Update a Challenge Outcome




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/consumer-engagement/v1/challenge-outcomes/1a857d33-5b74-4c76-9a60-a008ea652cc6', headers: headers, body: {"challengeId":"b95218d0-470f-11ea-b77f-2e728ce88125","consumerId":"b491d16e-470f-11ea-b77f-2e728ce88125","total":10000}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/challenge-outcomes/1a857d33-5b74-4c76-9a60-a008ea652cc6 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"challengeId":"b95218d0-470f-11ea-b77f-2e728ce88125","consumerId":"b491d16e-470f-11ea-b77f-2e728ce88125","total":10000}

PUT /challenge-outcomes/{challengeOutcomeId}

Updates a single challenge outcome by ID using the specified data. Updating a challenge outcome does not immediately update the overall rankings.

Parameters

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

Response Statuses

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

Retrieve a Single Challenge Outcome


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/consumer-engagement/v1/challenge-outcomes/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/consumer-engagement/v1/challenge-outcomes/1a857d33-5b74-4c76-9a60-a008ea652cc6 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
  "challengeId": "977022b8-470d-11ea-b77f-2e728ce88125",
  "consumerId": "86b87178-470d-11ea-b77f-2e728ce88125",
  "total": 10000,
  "rank": 5,
  "status": "COMPLETE",
  "unit": "STEPS",
  "updatedAt": "2018-12-15T12:23:12Z"
}

GET /challenge-outcomes/{challengeOutcomeId}

Retrieves a single challenge outcome by ID.

Parameters

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

Response Statuses

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

Create a Team Outcome




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/consumer-engagement/v1/team-outcomes', headers: headers, body: {"teamChallengeId":"b95218d0-470f-11ea-b77f-2e728ce88125","teamId":"be528s3e-470f-11ea-b77f-2e728ce88125","total":10000,"consumerId":"b491d16e-470f-11ea-b77f-2e728ce88125","status":"COMPLETE","unit":"STEPS"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/team-outcomes \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"teamChallengeId":"b95218d0-470f-11ea-b77f-2e728ce88125","teamId":"be528s3e-470f-11ea-b77f-2e728ce88125","total":10000,"consumerId":"b491d16e-470f-11ea-b77f-2e728ce88125","status":"COMPLETE","unit":"STEPS"}

{
  "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
  "teamChallengeId": "977022b8-470d-11ea-b77f-2e728ce88125",
  "teamId": "8034293c-470d-11ea-b77f-2e728ce88125",
  "consumerId": "86b87178-470d-11ea-b77f-2e728ce88125",
  "total": 10000
}

POST /team-outcomes

Creates an outcome for the consumer in a team challenge using the specified data. The total is used to calculate the rank of a consumer compared to totals from the other consumers in the team.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
201	Created	Created	ConsumerEngagementPublicApi_Entities_V1_Challenges_TeamOutcomeCreateResponse
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error

Retrieve a List of Team Outcomes


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/consumer-engagement/v1/team-outcomes', headers: headers)

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
      "teamChallengeId": "977022b8-470d-11ea-b77f-2e728ce88125",
      "teamId": "8034293c-470d-11ea-b77f-2e728ce88125",
      "consumerId": "86b87178-470d-11ea-b77f-2e728ce88125",
      "total": 10000,
      "rank": 5,
      "status": "COMPLETE",
      "unit": "STEPS",
      "updatedAt": "2018-12-15T12:23:12Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/team-outcomes?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/team-outcomes?offset=0&limit=20"
}

GET /team-outcomes

Retrieves a list of team outcomes. Outcomes by default are sorted by rank. Outcomes can be used for team leaderboards to compare how a particular consumer performed compared to all the other consumers of the team participating in the challenge.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
consumerId	query	array[string]	false	N/A	Filters the team outcomes by consumer ID.	-
teamChallengeId	query	array[string]	false	N/A	Filters the team outcomes by team challenge ID.	-
teamId	query	array[string]	false	N/A	Filters the team outcomes by team ID.	-
status	query	array[string]	false	N/A	Filters the team outcomes by the completion status of a consumer for the challenge. The status is based on whether the challenge goal is met. Possible status values are COMPLETE or INCOMPLETE.	-
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	TeamOutcomes
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error

Delete a Team Outcome


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/consumer-engagement/v1/team-outcomes/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/consumer-engagement/v1/team-outcomes/1a857d33-5b74-4c76-9a60-a008ea652cc6 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /team-outcomes/{teamOutcomeId}

Deletes a single team outcome by ID. Deleting a team outcome does not immediately update the overall rankings.

Parameters

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

Response Statuses

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

Update a Team Outcome




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/consumer-engagement/v1/team-outcomes/1a857d33-5b74-4c76-9a60-a008ea652cc6', headers: headers, body: {"teamChallengeId":"b95218d0-470f-11ea-b77f-2e728ce88125","teamId":"be528s3e-470f-11ea-b77f-2e728ce88125","total":10000,"consumerId":"b491d16e-470f-11ea-b77f-2e728ce88125","status":"COMPLETE","unit":"STEPS"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/team-outcomes/1a857d33-5b74-4c76-9a60-a008ea652cc6 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"teamChallengeId":"b95218d0-470f-11ea-b77f-2e728ce88125","teamId":"be528s3e-470f-11ea-b77f-2e728ce88125","total":10000,"consumerId":"b491d16e-470f-11ea-b77f-2e728ce88125","status":"COMPLETE","unit":"STEPS"}

PUT /team-outcomes/{teamOutcomeId}

Updates a single team outcome by ID using the specified data. Updating a team outcome does not immediately update the overall rankings and status.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
teamOutcomeId	path	string	true	N/A	The ID of the team outcome.	-
body	body	putTeamOutcomes	true	N/A	No description	-

Response Statuses

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

Retrieve a Single Team Outcome


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/consumer-engagement/v1/team-outcomes/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/consumer-engagement/v1/team-outcomes/1a857d33-5b74-4c76-9a60-a008ea652cc6 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
  "teamChallengeId": "977022b8-470d-11ea-b77f-2e728ce88125",
  "teamId": "8034293c-470d-11ea-b77f-2e728ce88125",
  "consumerId": "86b87178-470d-11ea-b77f-2e728ce88125",
  "total": 10000,
  "rank": 5,
  "status": "COMPLETE",
  "unit": "STEPS",
  "updatedAt": "2018-12-15T12:23:12Z"
}

GET /team-outcomes/{teamOutcomeId}

Retrieves a single team outcome by ID.

Parameters

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

Response Statuses

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

Create a Team Challenge Outcome




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/consumer-engagement/v1/team-challenge-outcomes', headers: headers, body: {"teamChallengeId":"b95218d0-470f-11ea-b77f-2e728ce88125","teamId":"be528s3e-470f-11ea-b77f-2e728ce88125","total":10000,"status":"COMPLETE","unit":"STEPS","average":"5000.50"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/team-challenge-outcomes \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"teamChallengeId":"b95218d0-470f-11ea-b77f-2e728ce88125","teamId":"be528s3e-470f-11ea-b77f-2e728ce88125","total":10000,"status":"COMPLETE","unit":"STEPS","average":"5000.50"}

{
  "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
  "teamChallengeId": "977022b8-470d-11ea-b77f-2e728ce88125",
  "teamId": "8034293c-470d-11ea-b77f-2e728ce88125",
  "total": 10000
}

POST /team-challenge-outcomes

Creates an outcome for the team in a team challenge using the specified data. The total is used to calculate the rank of a team compared to totals from other teams in a team challenge.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
201	Created	Created	ConsumerEngagementPublicApi_Entities_V1_Challenges_TeamChallengeOutcomeCreateResponse
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error

Retrieve a List of Team Challenge Outcomes


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/consumer-engagement/v1/team-challenge-outcomes', headers: headers)

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
      "teamChallengeId": "977022b8-470d-11ea-b77f-2e728ce88125",
      "teamId": "8034293c-470d-11ea-b77f-2e728ce88125",
      "total": 10000,
      "average": 5000.5,
      "rank": 5,
      "status": "COMPLETE",
      "unit": "STEPS",
      "updatedAt": "2018-12-15T12:23:12Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/team-challenge-outcomes?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/team-challenge-outcomes?offset=0&limit=20"
}

GET /team-challenge-outcomes

Retrieves a list of team challenge outcomes. Outcomes by default are sorted by rank. Outcomes can be used for team challenge leaderboards to compare how a particular team performed compared to all the other teams participating in the team challenge.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
teamChallengeId	query	array[string]	false	N/A	Filters the team challenge outcomes by team challenge ID.	-
teamId	query	array[string]	false	N/A	Filters the team challenge outcomes by team ID.	-
status	query	array[string]	false	N/A	Filters the team challenge outcomes by the completion status of a team for the challenge. The status is based on whether the team met the challenge goal. Possible status values are COMPLETE or INCOMPLETE.	-
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	TeamChallengeOutcomes
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error

Delete a Team Challenge Outcome


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/consumer-engagement/v1/team-challenge-outcomes/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/consumer-engagement/v1/team-challenge-outcomes/1a857d33-5b74-4c76-9a60-a008ea652cc6 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /team-challenge-outcomes/{teamChallengeOutcomeId}

Deletes a single team challenge outcome by ID. Deleting a team challenge outcome does not immediately update the overall rankings.

Parameters

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

Response Statuses

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

Update a Team Challenge Outcome




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/consumer-engagement/v1/team-challenge-outcomes/1a857d33-5b74-4c76-9a60-a008ea652cc6', headers: headers, body: {"teamChallengeId":"b95218d0-470f-11ea-b77f-2e728ce88125","teamId":"be528s3e-470f-11ea-b77f-2e728ce88125","total":10000,"status":"COMPLETE","unit":"STEPS","average":"5000.50"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/team-challenge-outcomes/1a857d33-5b74-4c76-9a60-a008ea652cc6 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"teamChallengeId":"b95218d0-470f-11ea-b77f-2e728ce88125","teamId":"be528s3e-470f-11ea-b77f-2e728ce88125","total":10000,"status":"COMPLETE","unit":"STEPS","average":"5000.50"}

PUT /team-challenge-outcomes/{teamChallengeOutcomeId}

Updates a single team challenge outcome by ID using the specified data. Updating a team challenge outcome does not immediately update the overall rankings.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
teamChallengeOutcomeId	path	string	true	N/A	The ID of the team challenge outcome.	-
body	body	putTeamChallengeOutcomes	true	N/A	No description	-

Response Statuses

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

Retrieve a Single Team Challenge Outcome


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/consumer-engagement/v1/team-challenge-outcomes/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/consumer-engagement/v1/team-challenge-outcomes/1a857d33-5b74-4c76-9a60-a008ea652cc6 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "94b44ea3-fb6b-4245-886b-caa8e156f125",
  "teamChallengeId": "977022b8-470d-11ea-b77f-2e728ce88125",
  "teamId": "8034293c-470d-11ea-b77f-2e728ce88125",
  "total": 10000,
  "average": 5000.5,
  "rank": 5,
  "status": "COMPLETE",
  "unit": "STEPS",
  "updatedAt": "2018-12-15T12:23:12Z"
}

GET /team-challenge-outcomes/{teamChallengeOutcomeId}

Retrieves a single team challenge outcome by ID

Parameters

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

Response Statuses

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

Create a Goal Observation




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/consumer-engagement/v1/goal-observations', headers: headers, body: {"consumer":{"id":"94b44ea3-fb6b-4245-886b-caa8e156f125"},"goal":{"id":"5e7f792f-9817-441f-857a-d8c88420711b"},"value":2,"unit":"CUPS","performedAt":"2019-08-20T12:23:12Z","timeZone":"America/New_York"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/goal-observations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"consumer":{"id":"94b44ea3-fb6b-4245-886b-caa8e156f125"},"goal":{"id":"5e7f792f-9817-441f-857a-d8c88420711b"},"value":2,"unit":"CUPS","performedAt":"2019-08-20T12:23:12Z","timeZone":"America/New_York"}

{
  "id": "74b44ea3-fb6b-4245-886b-caa8e156f125",
  "consumer": {
    "id": "2281caf2-4757-11ea-b77f-2e728ce88125"
  },
  "goal": {
    "id": "8dc5e868-6250-4c4f-aeb6-6401029cda9d"
  },
  "value": 2,
  "unit": "CUPS",
  "performedAt": "2019-08-20T12:23:12Z",
  "timeZone": "America/New_York",
  "createdAt": "2019-09-15T11:19:11Z",
  "updatedAt": "2020-01-01T12:12:12Z"
}

POST /goal-observations

Creates a goal observation using the specified parameters. A goal observation is tied to a consumer and a goal. Goal observations are used in the challenges product to allow consumers to track their progress in a challenge. Observations for goals with a null value and unit also have a null value and unit. In those scenarios, the observation affirms the consumer completed the goal on the specified date.

Parameters

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

Response Statuses

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

Retrieve a list of Goal Observations


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/consumer-engagement/v1/goal-observations', headers: headers)

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "74b44ea3-fb6b-4245-886b-caa8e156f125",
      "consumer": {
        "id": "2281caf2-4757-11ea-b77f-2e728ce88125"
      },
      "goal": {
        "id": "8dc5e868-6250-4c4f-aeb6-6401029cda9d"
      },
      "value": 2,
      "unit": "CUPS",
      "performedAt": "2019-08-20T12:23:12Z",
      "timeZone": "America/New_York",
      "createdAt": "2019-09-15T11:19:11Z",
      "updatedAt": "2020-01-01T12:12:12Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/goal-observations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/goal-observations?offset=0&limit=20"
}

GET /goal-observations

Retrieves a list of goal observations.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
consumerId	query	array[string]	false	N/A	One or more consumer IDs for which to get observations.	-
goalId	query	array[string]	false	N/A	One or more goal IDs for which to get observations.	-
startsAt	query	string	false	N/A	The starting date and time by which to filter observations.	-
endsAt	query	string	false	N/A	The ending date and time by which to filter observations.	-
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	GoalObservations
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Delete a Goal Observation


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/consumer-engagement/v1/goal-observations/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/consumer-engagement/v1/goal-observations/1a857d33-5b74-4c76-9a60-a008ea652cc6 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /goal-observations/{goalObservationId}

Deletes a single goal observation by ID.

Parameters

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

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 Goal Observation




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/consumer-engagement/v1/goal-observations/1a857d33-5b74-4c76-9a60-a008ea652cc6', headers: headers, body: {"goal":{"id":"5e7f792f-9817-441f-857a-d8c88420711b"},"value":2,"unit":"CUPS","performedAt":"2019-08-20T12:23:12Z","timeZone":"America/New_York"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/goal-observations/1a857d33-5b74-4c76-9a60-a008ea652cc6 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"goal":{"id":"5e7f792f-9817-441f-857a-d8c88420711b"},"value":2,"unit":"CUPS","performedAt":"2019-08-20T12:23:12Z","timeZone":"America/New_York"}

PUT /goal-observations/{goalObservationId}

Updates a goal observation by ID.

Parameters

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

Response Statuses

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

Retrieve a single Goal Observation


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/consumer-engagement/v1/goal-observations/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/consumer-engagement/v1/goal-observations/1a857d33-5b74-4c76-9a60-a008ea652cc6 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "74b44ea3-fb6b-4245-886b-caa8e156f125",
  "consumer": {
    "id": "2281caf2-4757-11ea-b77f-2e728ce88125"
  },
  "goal": {
    "id": "8dc5e868-6250-4c4f-aeb6-6401029cda9d"
  },
  "value": 2,
  "unit": "CUPS",
  "performedAt": "2019-08-20T12:23:12Z",
  "timeZone": "America/New_York",
  "createdAt": "2019-09-15T11:19:11Z",
  "updatedAt": "2020-01-01T12:12:12Z"
}

GET /goal-observations/{goalObservationId}

Retrieves a single goal observation by ID.

Parameters

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

Response Statuses

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

Retrieve a List of Aggregated Goal Observations


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/consumer-engagement/v1/aggregated-goal-observations',
  query: {
  'goalId' => 'string',
'consumerId' => 'array[string]'
}, headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/aggregated-goal-observations?goalId=type,string&consumerId=type,array,items,%5Bobject%20Object%5D \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "consumer": {
        "id": "2281caf2-4757-11ea-b77f-2e728ce88125"
      },
      "goal": {
        "id": "8dc5e868-6250-4c4f-aeb6-6401029cda9d"
      },
      "value": 2,
      "unit": "CUPS",
      "frequency": "DAILY",
      "frequencyStartsAt": "2019-08-20",
      "timeZone": "America/New_York"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/aggregated-goal-observations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/aggregated-goal-observations?offset=0&limit=20"
}

GET /aggregated-goal-observations

Retrieves a list of aggregated goal observations. Aggregated observations are combined observations for a challenge over a specified frequency and are used to track a consumer’s progress in a challenge. Observations can be aggregated on a daily or weekly basis. If the goal passed does not have a value, a bad request occurs.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
goalId	query	string	true	N/A	The goal ID to by which to filter observations.	-
consumerId	query	array[string]	true	N/A	One or more consumer IDs for which to get observations.	-
startsAt	query	string	false	N/A	The start date by which to filter observations.	-
endsAt	query	string	false	N/A	The end date by which to filter observations.	-
frequency	query	string	false	N/A	The frequency on which to aggregate observations. This value can be `DAILY` or `WEEKLY`.	-
timeZone	query	string	false	N/A	The time zone used to configure the date and time on which to aggregate observations.	-
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	AggregatedGoalObservations
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Questionnaires

Questionnaires are structured sets of questions and instructions presented to collect answers from Oracle Health Data Intelligence consumers. The Questionnaire endpoints enable the creation and presentation of Questionnaires and their answers. Questionnaires can be used to collect data for analysis or to customize the behavior of Health Data Intelligence wellness campaigns.

Retrieve a List of Questionnaire Definitions


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/questionnaire-definitions', headers: headers)

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "e61dd2fa-702d-11e9-a923-1681be663d3e",
      "questionnaireId": "ace20324-a0b9-11e8-98d0-529269fb1459",
      "name": "Cerner Demo Questions Before You Start 2021",
      "type": "CAMPAIGN",
      "locale": "en-US",
      "description": "\\\"Cerner Demo Questions Before You Start 2021\\\" gathers general information from the consumer when they complete a `REGISTRATION WORKFLOW`.",
      "code": {
        "system": "urn:ietf:rfc:3986",
        "code": "2-16-840-1-113883-6-1",
        "display": "something that's not a Personal Health Assessment"
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/questionnaire-definitions?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/questionnaire-definitions?offset=0&limit=20"
}

GET /questionnaire-definitions

Retrieves a list of all the available Questionnaire definitions. A Questionnaire Definition stores metadata for a Questionnaire. Questionnaire Sections, Questionnaire Subsections, and Questionnaire Questions are all scoped to a Questionnaire Definition. The Questionnaire Definition may be changed at anytime but it will not affect a Published Questionnaire. The Questionnaire Definition does not represent a complete Questionnaire.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
questionnaireId	query	string	false	N/A	Filters by the ID of a questionnaire.	-
type	query	array[string]	false	N/A	Filters by questionnaire types.	-
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	QuestionnaireDefinitions
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a Questionnaire Definition




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/questionnaire-definitions', headers: headers, body: {"name":"Cerner Demo Questions Before You Start 2021","questionnaireId":"ace20324-a0b9-11e8-98d0-529269fb1459","type":"CAMPAIGN","locale":"en-US","description":"\\\"Cerner Demo Questions Before You Start 2021\\\" gathers general information from the consumer when they complete a `REGISTRATION WORKFLOW`.","code":{"system":"urn:ietf:rfc:3986","code":"2-16-840-1-113883-6-1","display":"something that's not a Personal Health Assessment"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/questionnaire-definitions \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Cerner Demo Questions Before You Start 2021","questionnaireId":"ace20324-a0b9-11e8-98d0-529269fb1459","type":"CAMPAIGN","locale":"en-US","description":"\\\"Cerner Demo Questions Before You Start 2021\\\" gathers general information from the consumer when they complete a `REGISTRATION WORKFLOW`.","code":{"system":"urn:ietf:rfc:3986","code":"2-16-840-1-113883-6-1","display":"something that's not a Personal Health Assessment"}}

{
  "id": "e61dd2fa-702d-11e9-a923-1681be663d3e",
  "questionnaireId": "ace20324-a0b9-11e8-98d0-529269fb1459",
  "name": "Cerner Demo Questions Before You Start 2021",
  "type": "CAMPAIGN",
  "locale": "en-US",
  "description": "\\\"Cerner Demo Questions Before You Start 2021\\\" gathers general information from the consumer when they complete a `REGISTRATION WORKFLOW`.",
  "code": {
    "system": "urn:ietf:rfc:3986",
    "code": "2-16-840-1-113883-6-1",
    "display": "something that's not a Personal Health Assessment"
  }
}

POST /questionnaire-definitions

Creates a new Questionnaire definition. A Questionnaire Definition stores metadata for a Questionnaire. Questionnaire Sections, Questionnaire Subsections, and Questionnaire Questions are all scoped to a Questionnaire Definition. The Questionnaire Definition may be changed at anytime but it will not affect a Published Questionnaire. The Questionnaire Definition does not represent a complete Questionnaire.

Parameters

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

Response Statuses

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

Delete a Questionnaire Definition


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/consumer-engagement/v1/questionnaire-definitions/e61dd2fa-702d-11e9-a923-1681be663d3e', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/questionnaire-definitions/e61dd2fa-702d-11e9-a923-1681be663d3e \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /questionnaire-definitions/{questionnaireDefinitionId}

Deletes a Questionnaire definition. A Questionnaire Definition stores metadata for a Questionnaire. Questionnaire Sections, Questionnaire Subsections, and Questionnaire Questions are all scoped to a Questionnaire Definition. The Questionnaire Definition may be changed at anytime but it will not affect a Published Questionnaire. The Questionnaire Definition does not represent a complete Questionnaire.

Parameters

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

Response Statuses

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

Update a Questionnaire Definition




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

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

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/questionnaire-definitions/e61dd2fa-702d-11e9-a923-1681be663d3e', headers: headers, body: {"name":"Cerner Demo Questions Before You Start 2021","questionnaireId":"ace20324-a0b9-11e8-98d0-529269fb1459","type":"CAMPAIGN","locale":"en-US","description":"\\\"Cerner Demo Questions Before You Start 2021\\\" gathers general information from the consumer when they complete a `REGISTRATION WORKFLOW`.","code":{"system":"urn:ietf:rfc:3986","code":"2-16-840-1-113883-6-1","display":"something that's not a Personal Health Assessment"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/questionnaire-definitions/e61dd2fa-702d-11e9-a923-1681be663d3e \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Cerner Demo Questions Before You Start 2021","questionnaireId":"ace20324-a0b9-11e8-98d0-529269fb1459","type":"CAMPAIGN","locale":"en-US","description":"\\\"Cerner Demo Questions Before You Start 2021\\\" gathers general information from the consumer when they complete a `REGISTRATION WORKFLOW`.","code":{"system":"urn:ietf:rfc:3986","code":"2-16-840-1-113883-6-1","display":"something that's not a Personal Health Assessment"}}

PUT /questionnaire-definitions/{questionnaireDefinitionId}

Updates a Questionnaire definition. A Questionnaire Definition stores metadata for a Questionnaire. Questionnaire Sections, Questionnaire Subsections, and Questionnaire Questions are all scoped to a Questionnaire Definition. The Questionnaire Definition may be changed at anytime but it will not affect a Published Questionnaire. The Questionnaire Definition does not represent a complete Questionnaire.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
questionnaireDefinitionId	path	string	true	N/A	The ID of the Questionnaire definition.	-
body	body	putQuestionnaireDefinitions	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 Questionnaire Definition


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/questionnaire-definitions/e61dd2fa-702d-11e9-a923-1681be663d3e', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/questionnaire-definitions/e61dd2fa-702d-11e9-a923-1681be663d3e \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "e61dd2fa-702d-11e9-a923-1681be663d3e",
  "questionnaireId": "ace20324-a0b9-11e8-98d0-529269fb1459",
  "name": "Cerner Demo Questions Before You Start 2021",
  "type": "CAMPAIGN",
  "locale": "en-US",
  "description": "\\\"Cerner Demo Questions Before You Start 2021\\\" gathers general information from the consumer when they complete a `REGISTRATION WORKFLOW`.",
  "code": {
    "system": "urn:ietf:rfc:3986",
    "code": "2-16-840-1-113883-6-1",
    "display": "something that's not a Personal Health Assessment"
  }
}

GET /questionnaire-definitions/{questionnaireDefinitionId}

Retrieves a single Questionnaire definition. A Questionnaire Definition stores metadata for a Questionnaire. Questionnaire Sections, Questionnaire Subsections, and Questionnaire Questions are all scoped to a Questionnaire Definition. The Questionnaire Definition may be changed at anytime but it will not affect a Published Questionnaire. The Questionnaire Definition does not represent a complete Questionnaire.

Parameters

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

Response Statuses

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

Retrieve a List of Questionnaire Sections


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/consumer-engagement/v1/questionnaire-definitions/e61dd2fa-702d-11e9-a923-1681be663d3e/sections', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/questionnaire-definitions/e61dd2fa-702d-11e9-a923-1681be663d3e/sections \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "ace20324-a0b9-11e8-98d0-529269fb1459",
      "name": "Nutrition",
      "description": "The nutritional assessment is an evaluation of dietary intake and nutrition status to identify the presence of malnutrition, obesity, and so on.",
      "position": 1,
      "code": {
        "system": "urn:ietf:rfc:3986",
        "code": "2-16-840-1-113883-6-1",
        "display": "something that's not a Personal Health Assessment"
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/questionnaire/v1/questionnaire-definitions/e61dd2fa-702d-11e9-a923-1681be663d3e/sections?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/questionnaire/v1/questionnaire-definitions/e61dd2fa-702d-11e9-a923-1681be663d3e/sections?offset=0&limit=20"
}

GET /questionnaire-definitions/{questionnaireDefinitionId}/sections

Retrieves a list of all the available sections of a Questionnaire definition.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
questionnaireDefinitionId	path	string	true	N/A	The ID of the Questionnaire 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	QuestionnaireSections
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a Questionnaire Section




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/consumer-engagement/v1/questionnaire-definitions/e61dd2fa-702d-11e9-a923-1681be663d3e/sections', headers: headers, body: {"name":"Nutrition","description":"The nutritional assessment is an evaluation of dietary intake and nutrition status to identify the presence of malnutrition, obesity, and so on.","position":1,"code":{"system":"urn:ietf:rfc:3986","code":"2-16-840-1-113883-6-1","display":"something that's not a Personal Health Assessment"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/questionnaire-definitions/e61dd2fa-702d-11e9-a923-1681be663d3e/sections \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Nutrition","description":"The nutritional assessment is an evaluation of dietary intake and nutrition status to identify the presence of malnutrition, obesity, and so on.","position":1,"code":{"system":"urn:ietf:rfc:3986","code":"2-16-840-1-113883-6-1","display":"something that's not a Personal Health Assessment"}}

{
  "id": "ace20324-a0b9-11e8-98d0-529269fb1459",
  "name": "Nutrition",
  "description": "The nutritional assessment is an evaluation of dietary intake and nutrition status to identify the presence of malnutrition, obesity, and so on.",
  "position": 1,
  "code": {
    "system": "urn:ietf:rfc:3986",
    "code": "2-16-840-1-113883-6-1",
    "display": "something that's not a Personal Health Assessment"
  }
}

POST /questionnaire-definitions/{questionnaireDefinitionId}/sections

Creates a new Questionnaire section for a Questionnaire. A Questionnaire section is a structured group that contains subsections and questions for a Questionnaire.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
questionnaireDefinitionId	path	string	true	N/A	The ID of the Questionnaire definition.	-
body	body	postQuestionnaireDefinitionsQuestionnairedefinitionidSections	true	N/A	No description	-

Response Statuses

Status	Meaning	Description	Schema
201	Created	Created	ConsumerEngagementPublicApi_Entities_V1_Questionnaires_QuestionnaireSection
400	Bad Request	Bad Request. The response includes error details with a reason field that can help identify the issue. The following reasons are possible, among others: - `PositionNotUnique` A section already exists for the specified position.	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Delete a Questionnaire Section


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/consumer-engagement/v1/questionnaire-definitions/e61dd2fa-702d-11e9-a923-1681be663d3e/sections/9a7be7c8-5c65-11e9-8647-d663bd873d93', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/questionnaire-definitions/e61dd2fa-702d-11e9-a923-1681be663d3e/sections/9a7be7c8-5c65-11e9-8647-d663bd873d93 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /questionnaire-definitions/{questionnaireDefinitionId}/sections/{sectionId}

Deletes a Questionnaire section for a Questionnaire definition.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
questionnaireDefinitionId	path	string	true	N/A	The ID of the Questionnaire definition.	-
sectionId	path	string	true	N/A	The ID of the Questionnaire section.	-

Response Statuses

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

Update a Questionnaire Section




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/consumer-engagement/v1/questionnaire-definitions/e61dd2fa-702d-11e9-a923-1681be663d3e/sections/9a7be7c8-5c65-11e9-8647-d663bd873d93', headers: headers, body: {"name":"Nutrition","description":"The nutritional assessment is an evaluation of dietary intake and nutrition status to identify the presence of malnutrition, obesity, and so on.","position":1,"code":{"system":"urn:ietf:rfc:3986","code":"2-16-840-1-113883-6-1","display":"something that's not a Personal Health Assessment"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/questionnaire-definitions/e61dd2fa-702d-11e9-a923-1681be663d3e/sections/9a7be7c8-5c65-11e9-8647-d663bd873d93 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Nutrition","description":"The nutritional assessment is an evaluation of dietary intake and nutrition status to identify the presence of malnutrition, obesity, and so on.","position":1,"code":{"system":"urn:ietf:rfc:3986","code":"2-16-840-1-113883-6-1","display":"something that's not a Personal Health Assessment"}}

PUT /questionnaire-definitions/{questionnaireDefinitionId}/sections/{sectionId}

Updates a Questionnaire section for a Questionnaire definition.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
questionnaireDefinitionId	path	string	true	N/A	The ID of the Questionnaire definition.	-
sectionId	path	string	true	N/A	The ID of the Questionnaire section.	-
body	body	putQuestionnaireDefinitionsQuestionnairedefinitionidSections	true	N/A	No description	-

Response Statuses

Status	Meaning	Description	Schema
204	No Content	Updated	None
400	Bad Request	Bad Request. The response includes error details with a reason field that can help identify the issue. The following reasons are possible, among others: - `PositionNotUnique` A section already exists for the specified position.	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Retrieve a Single Questionnaire Section


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/consumer-engagement/v1/questionnaire-definitions/e61dd2fa-702d-11e9-a923-1681be663d3e/sections/9a7be7c8-5c65-11e9-8647-d663bd873d93', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/questionnaire-definitions/e61dd2fa-702d-11e9-a923-1681be663d3e/sections/9a7be7c8-5c65-11e9-8647-d663bd873d93 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "ace20324-a0b9-11e8-98d0-529269fb1459",
  "name": "Nutrition",
  "description": "The nutritional assessment is an evaluation of dietary intake and nutrition status to identify the presence of malnutrition, obesity, and so on.",
  "position": 1,
  "code": {
    "system": "urn:ietf:rfc:3986",
    "code": "2-16-840-1-113883-6-1",
    "display": "something that's not a Personal Health Assessment"
  }
}

GET /questionnaire-definitions/{questionnaireDefinitionId}/sections/{sectionId}

Retrieves a single Questionnaire section of a Questionnaire definition for a Health Data Intelligence tenant.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
questionnaireDefinitionId	path	string	true	N/A	The ID of the Questionnaire definition.	-
sectionId	path	string	true	N/A	The ID of the Questionnaire section.	-

Response Statuses

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

Retrieve a List of Questionnaire Subsections


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/consumer-engagement/v1/questionnaire-definitions/e61dd2fa-702d-11e9-a923-1681be663d3e/subsections', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/questionnaire-definitions/e61dd2fa-702d-11e9-a923-1681be663d3e/subsections \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "9a7be7c8-5c65-11e9-8647-d663bd873d93",
      "name": "Nutrition-Fats",
      "description": "Nutrition-Fats is the subset of nutrition questions that evaluates fats in the diet of Health Data Intelligence consumers.",
      "position": 1,
      "code": {
        "system": "urn:ietf:rfc:3986",
        "code": "2-16-840-1-113883-6-1",
        "display": "something that's not a Personal Health Assessment"
      },
      "section": {
        "id": "12345678-120b-4c1e-81e4-3d3ae9c7580e"
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/questionnaire-definitions/e61dd2fa-702d-11e9-a923-1681be663d3e/subsections?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/questionnaire-definitions/e61dd2fa-702d-11e9-a923-1681be663d3e/subsections?offset=0&limit=20"
}

GET /questionnaire-definitions/{questionnaireDefinitionId}/subsections

Retrieves a list of all the available subsections for a Questionnaire definition.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
questionnaireDefinitionId	path	string	true	N/A	The ID of the Questionnaire 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	QuestionnaireSubsections
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a Questionnaire Subsection




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/consumer-engagement/v1/questionnaire-definitions/e61dd2fa-702d-11e9-a923-1681be663d3e/subsections', headers: headers, body: {"name":"Nutrition-Fats","description":"Nutrition-Fats is the subset of nutrition questions that evaluates fats in the diet of Health Data Intelligence consumers.","position":1,"code":"2-16-840-1-113883-6-1","system":"urn:ietf:rfc:3986","display":"something that's not a Personal Health Assessment","section":{"id":"12345678-120b-4c1e-81e4-3d3ae9c7580e"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/questionnaire-definitions/e61dd2fa-702d-11e9-a923-1681be663d3e/subsections \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Nutrition-Fats","description":"Nutrition-Fats is the subset of nutrition questions that evaluates fats in the diet of Health Data Intelligence consumers.","position":1,"code":"2-16-840-1-113883-6-1","system":"urn:ietf:rfc:3986","display":"something that's not a Personal Health Assessment","section":{"id":"12345678-120b-4c1e-81e4-3d3ae9c7580e"}}

{
  "id": "9a7be7c8-5c65-11e9-8647-d663bd873d93",
  "name": "Nutrition-Fats",
  "description": "Nutrition-Fats is the subset of nutrition questions that evaluates fats in the diet of Health Data Intelligence consumers.",
  "position": 1,
  "code": {
    "system": "urn:ietf:rfc:3986",
    "code": "2-16-840-1-113883-6-1",
    "display": "something that's not a Personal Health Assessment"
  },
  "section": {
    "id": "12345678-120b-4c1e-81e4-3d3ae9c7580e"
  }
}

POST /questionnaire-definitions/{questionnaireDefinitionId}/subsections

Creates a new Questionnaire subsection for a Questionnaire. A Questionnaire subsection is a structured subgroup in a Questionnaire section that contains questions for a Questionnaire.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
questionnaireDefinitionId	path	string	true	N/A	The ID of the Questionnaire definition.	-
body	body	postQuestionnaireDefinitionsQuestionnairedefinitionidSubsections	true	N/A	No description	-

Response Statuses

Status	Meaning	Description	Schema
201	Created	Created	ConsumerEngagementPublicApi_Entities_V1_Questionnaires_QuestionnaireSubsection
400	Bad Request	Bad Request. The response includes error details with a reason field that can help identify the issue. The following reasons are possible, among others: - `SectionNotFound` The Questionnaire section specified for the subsection does not exist. - `PositionNotUnique` A section already exists for the specified position.	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Delete a Questionnaire Subsection


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/consumer-engagement/v1/questionnaire-definitions/e61dd2fa-702d-11e9-a923-1681be663d3e/subsections/ace20324-a0b9-11e8-98d0-529269fb1459', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/questionnaire-definitions/e61dd2fa-702d-11e9-a923-1681be663d3e/subsections/ace20324-a0b9-11e8-98d0-529269fb1459 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /questionnaire-definitions/{questionnaireDefinitionId}/subsections/{subsectionId}

Deletes a Questionnaire subsection for a Questionnaire definition.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
questionnaireDefinitionId	path	string	true	N/A	The ID of the Questionnaire definition.	-
subsectionId	path	string	true	N/A	The ID of the questionnaire subsection.	-

Response Statuses

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

Update a Questionnaire Subsection




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/consumer-engagement/v1/questionnaire-definitions/e61dd2fa-702d-11e9-a923-1681be663d3e/subsections/ace20324-a0b9-11e8-98d0-529269fb1459', headers: headers, body: {"name":"Nutrition-Fats","description":"Nutrition-Fats is the subset of nutrition questions that evaluates fats in the diet of Health Data Intelligence consumers.","position":1,"code":"2-16-840-1-113883-6-1","system":"urn:ietf:rfc:3986","display":"something that's not a Personal Health Assessment","section":{"id":"12345678-120b-4c1e-81e4-3d3ae9c7580e"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/questionnaire-definitions/e61dd2fa-702d-11e9-a923-1681be663d3e/subsections/ace20324-a0b9-11e8-98d0-529269fb1459 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Nutrition-Fats","description":"Nutrition-Fats is the subset of nutrition questions that evaluates fats in the diet of Health Data Intelligence consumers.","position":1,"code":"2-16-840-1-113883-6-1","system":"urn:ietf:rfc:3986","display":"something that's not a Personal Health Assessment","section":{"id":"12345678-120b-4c1e-81e4-3d3ae9c7580e"}}

PUT /questionnaire-definitions/{questionnaireDefinitionId}/subsections/{subsectionId}

Updates a Questionnaire subsection for a Questionnaire definition.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
questionnaireDefinitionId	path	string	true	N/A	The ID of the Questionnaire definition.	-
subsectionId	path	string	true	N/A	The ID of the questionnaire subsection.	-
body	body	putQuestionnaireDefinitionsQuestionnairedefinitionidSubsections	true	N/A	No description	-

Response Statuses

Status	Meaning	Description	Schema
204	No Content	Updated	None
400	Bad Request	Bad Request. The response includes error details with a reason field that can help identify the issue. The following reasons are possible, among others: - `SectionNotFound` The Questionnaire section specified for the subsection does not exist. - `PositionNotUnique` A section already exists for the specified position.	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Retrieve a Single Questionnaire Subsection


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/consumer-engagement/v1/questionnaire-definitions/e61dd2fa-702d-11e9-a923-1681be663d3e/subsections/ace20324-a0b9-11e8-98d0-529269fb1459', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/questionnaire-definitions/e61dd2fa-702d-11e9-a923-1681be663d3e/subsections/ace20324-a0b9-11e8-98d0-529269fb1459 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "9a7be7c8-5c65-11e9-8647-d663bd873d93",
  "name": "Nutrition-Fats",
  "description": "Nutrition-Fats is the subset of nutrition questions that evaluates fats in the diet of Health Data Intelligence consumers.",
  "position": 1,
  "code": {
    "system": "urn:ietf:rfc:3986",
    "code": "2-16-840-1-113883-6-1",
    "display": "something that's not a Personal Health Assessment"
  },
  "section": {
    "id": "12345678-120b-4c1e-81e4-3d3ae9c7580e"
  }
}

GET /questionnaire-definitions/{questionnaireDefinitionId}/subsections/{subsectionId}

Retrieves a single Questionnaire subsection for a Questionnaire definition.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
subsectionId	path	string	true	N/A	The ID of the questionnaire subsection.	-
questionnaireDefinitionId	path	string	true	N/A	The ID of the Questionnaire definition.	-

Response Statuses

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

Retrieve a List of Questionnaire Questions


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/consumer-engagement/v1/questionnaire-definitions/e61dd2fa-702d-11e9-a923-1681be663d3e/questions', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/questionnaire-definitions/e61dd2fa-702d-11e9-a923-1681be663d3e/questions \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "ace20324-a0b9-11e8-98d0-529269fb1459",
      "text": "How many times do you eat junk food in a week?",
      "type": "RANGE",
      "description": "Junk food is food that is highly processed; high in calories, sugars, salt, and trans fat; and low in nutrients.",
      "acceptsMultipleAnswers": true,
      "required": true,
      "position": 1,
      "section": {
        "id": "12345678-120b-4c1e-81e4-3d3ae9c7580e"
      },
      "subsection": {
        "id": "9a7be4e4-5c65-11e9-8647-d663bd873d93"
      },
      "code": {
        "system": "urn:ietf:rfc:3986",
        "code": "2-16-840-1-113883-6-1",
        "display": "something that's not a Personal Health Assessment"
      },
      "options": [
        {
          "id": "bce10324-a0b9-11e8-98d0-529269fb1459",
          "choice": {
            "points": 5,
            "text": "Between 1 and 25"
          },
          "range": {
            "low": 1,
            "high": 7,
            "text": "Number of days in a week."
          }
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/questionnaire-definitions/e61dd2fa-702d-11e9-a923-1681be663d3e/questions?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/questionnaire-definitions/e61dd2fa-702d-11e9-a923-1681be663d3e/questions?offset=0&limit=20"
}

GET /questionnaire-definitions/{questionnaireDefinitionId}/questions

Retrieves a list of all of the available questions.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
questionnaireDefinitionId	path	string	true	N/A	The ID of the Questionnaire 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	QuestionnaireQuestions
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a Questionnaire Question




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/consumer-engagement/v1/questionnaire-definitions/e61dd2fa-702d-11e9-a923-1681be663d3e/questions', headers: headers, body: {"text":"How many times do you eat junk food in a week?","type":"RANGE","description":"Junk food is food that is highly processed; high in calories, sugars, salt, and trans fat; and low in nutrients.","acceptsMultipleAnswers":true,"required":true,"position":1,"section":{"id":"12345678-120b-4c1e-81e4-3d3ae9c7580e"},"subsection":{"id":"9a7be4e4-5c65-11e9-8647-d663bd873d93"},"code":{"system":"urn:ietf:rfc:3986","code":"2-16-840-1-113883-6-1","display":"something that's not a Personal Health Assessment"},"options":[{"choice":{"points":5,"text":"Between 1 and 25"},"range":{"low":1,"high":7,"text":"Number of days in a week."}}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/questionnaire-definitions/e61dd2fa-702d-11e9-a923-1681be663d3e/questions \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"text":"How many times do you eat junk food in a week?","type":"RANGE","description":"Junk food is food that is highly processed; high in calories, sugars, salt, and trans fat; and low in nutrients.","acceptsMultipleAnswers":true,"required":true,"position":1,"section":{"id":"12345678-120b-4c1e-81e4-3d3ae9c7580e"},"subsection":{"id":"9a7be4e4-5c65-11e9-8647-d663bd873d93"},"code":{"system":"urn:ietf:rfc:3986","code":"2-16-840-1-113883-6-1","display":"something that's not a Personal Health Assessment"},"options":[{"choice":{"points":5,"text":"Between 1 and 25"},"range":{"low":1,"high":7,"text":"Number of days in a week."}}]}

{
  "id": "ace20324-a0b9-11e8-98d0-529269fb1459",
  "text": "How many times do you eat junk food in a week?",
  "type": "RANGE",
  "description": "Junk food is food that is highly processed; high in calories, sugars, salt, and trans fat; and low in nutrients.",
  "acceptsMultipleAnswers": true,
  "required": true,
  "position": 1,
  "section": {
    "id": "12345678-120b-4c1e-81e4-3d3ae9c7580e"
  },
  "subsection": {
    "id": "9a7be4e4-5c65-11e9-8647-d663bd873d93"
  },
  "code": {
    "system": "urn:ietf:rfc:3986",
    "code": "2-16-840-1-113883-6-1",
    "display": "something that's not a Personal Health Assessment"
  },
  "options": [
    {
      "id": "bce10324-a0b9-11e8-98d0-529269fb1459",
      "choice": {
        "points": 5,
        "text": "Between 1 and 25"
      },
      "range": {
        "low": 1,
        "high": 7,
        "text": "Number of days in a week."
      }
    }
  ]
}

POST /questionnaire-definitions/{questionnaireDefinitionId}/questions

Creates a new Questionnaire question. A Questionnaire question defines the information necessary to guide the collection of answers from a Health Data Intelligence consumer about their health and habits.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
questionnaireDefinitionId	path	string	true	N/A	The ID of the Questionnaire definition.	-
body	body	postQuestionnaireDefinitionsQuestionnairedefinitionidQuestions	true	N/A	No description	-

Response Statuses

Status	Meaning	Description	Schema
201	Created	Created	ConsumerEngagementPublicApi_Entities_V1_Questionnaires_QuestionnaireQuestion
400	Bad Request	Bad Request. The response includes error details with a reason field that can help identify the issue. The following reasons are possible, among others: - `SectionNotFound` The Questionnaire section specified for the question does not exist. - `SubsectionNotFound` The Questionnaire subsection specified for the question does not exist. - `PositionNotUnique` A question already exists for the specified position. - `MissingOption` An option was not specified for a range, choice, or open choice question. - `InvalidOptionType` The type of option (choice or range) is not valid for the specified type of question.	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Delete a Questionnaire Question


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/consumer-engagement/v1/questionnaire-definitions/e61dd2fa-702d-11e9-a923-1681be663d3e/questions/ace20324-a0b9-11e8-98d0-529269fb1459', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/questionnaire-definitions/e61dd2fa-702d-11e9-a923-1681be663d3e/questions/ace20324-a0b9-11e8-98d0-529269fb1459 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /questionnaire-definitions/{questionnaireDefinitionId}/questions/{questionId}

Deletes a Questionnaire question.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
questionnaireDefinitionId	path	string	true	N/A	The ID of the Questionnaire definition.	-
questionId	path	string	true	N/A	The ID of the question.	-

Response Statuses

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

Update a Questionnaire Question




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/consumer-engagement/v1/questionnaire-definitions/e61dd2fa-702d-11e9-a923-1681be663d3e/questions/ace20324-a0b9-11e8-98d0-529269fb1459', headers: headers, body: {"text":"How many times do you eat junk food in a week?","type":"RANGE","description":"Junk food is food that is highly processed; high in calories, sugars, salt, and trans fat; and low in nutrients.","acceptsMultipleAnswers":true,"required":true,"position":1,"section":{"id":"12345678-120b-4c1e-81e4-3d3ae9c7580e"},"subsection":{"id":"9a7be4e4-5c65-11e9-8647-d663bd873d93"},"code":{"system":"urn:ietf:rfc:3986","code":"2-16-840-1-113883-6-1","display":"something that's not a Personal Health Assessment"},"options":[{"choice":{"points":5,"text":"Between 1 and 25"},"range":{"low":1,"high":7,"text":"Number of days in a week."}}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/questionnaire-definitions/e61dd2fa-702d-11e9-a923-1681be663d3e/questions/ace20324-a0b9-11e8-98d0-529269fb1459 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"text":"How many times do you eat junk food in a week?","type":"RANGE","description":"Junk food is food that is highly processed; high in calories, sugars, salt, and trans fat; and low in nutrients.","acceptsMultipleAnswers":true,"required":true,"position":1,"section":{"id":"12345678-120b-4c1e-81e4-3d3ae9c7580e"},"subsection":{"id":"9a7be4e4-5c65-11e9-8647-d663bd873d93"},"code":{"system":"urn:ietf:rfc:3986","code":"2-16-840-1-113883-6-1","display":"something that's not a Personal Health Assessment"},"options":[{"choice":{"points":5,"text":"Between 1 and 25"},"range":{"low":1,"high":7,"text":"Number of days in a week."}}]}

PUT /questionnaire-definitions/{questionnaireDefinitionId}/questions/{questionId}

Updates a Questionnaire question.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
questionnaireDefinitionId	path	string	true	N/A	The ID of the Questionnaire definition.	-
questionId	path	string	true	N/A	The ID of the question.	-
body	body	putQuestionnaireDefinitionsQuestionnairedefinitionidQuestions	true	N/A	No description	-

Response Statuses

Status	Meaning	Description	Schema
204	No Content	Updated	None
400	Bad Request	Bad Request. The response includes error details with a reason field that can help identify the issue. The following reasons are possible, among others: - `SectionNotFound` The Questionnaire section specified for the question does not exist. - `SubsectionNotFound` The Questionnaire subsection specified for the question does not exist. - `PositionNotUnique` A question already exists for the specified position. - `MissingOption` An option was not specified for a range, choice, or open choice question. - `InvalidOptionType` The type of option (choice or range) is not valid for the specified type of question.	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Retrieve a Single Questionnaire Question


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/consumer-engagement/v1/questionnaire-definitions/e61dd2fa-702d-11e9-a923-1681be663d3e/questions/ace20324-a0b9-11e8-98d0-529269fb1459', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/questionnaire-definitions/e61dd2fa-702d-11e9-a923-1681be663d3e/questions/ace20324-a0b9-11e8-98d0-529269fb1459 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "ace20324-a0b9-11e8-98d0-529269fb1459",
  "text": "How many times do you eat junk food in a week?",
  "type": "RANGE",
  "description": "Junk food is food that is highly processed; high in calories, sugars, salt, and trans fat; and low in nutrients.",
  "acceptsMultipleAnswers": true,
  "required": true,
  "position": 1,
  "section": {
    "id": "12345678-120b-4c1e-81e4-3d3ae9c7580e"
  },
  "subsection": {
    "id": "9a7be4e4-5c65-11e9-8647-d663bd873d93"
  },
  "code": {
    "system": "urn:ietf:rfc:3986",
    "code": "2-16-840-1-113883-6-1",
    "display": "something that's not a Personal Health Assessment"
  },
  "options": [
    {
      "id": "bce10324-a0b9-11e8-98d0-529269fb1459",
      "choice": {
        "points": 5,
        "text": "Between 1 and 25"
      },
      "range": {
        "low": 1,
        "high": 7,
        "text": "Number of days in a week."
      }
    }
  ]
}

GET /questionnaire-definitions/{questionnaireDefinitionId}/questions/{questionId}

Retrieves a single Questionnaire question.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
questionnaireDefinitionId	path	string	true	N/A	The ID of the Questionnaire definition.	-
questionId	path	string	true	N/A	The ID of the question.	-

Response Statuses

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

Clone Existing Published Questionnaire




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/consumer-engagement/v1/questionnaire-definitions/83193b19-60d1-4918-a23f-5e46e0ef4e02/clone', headers: headers, body: {"sections":["ace20324-a0b9-11e8-98d0-529269fb1459"],"type":"STANDARD","questionnaireId":"0459f2ec-06e2-43c1-881e-9aeb3a50c1cd","name":"Cerner Demo Questionnaire 2020"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/questionnaire-definitions/83193b19-60d1-4918-a23f-5e46e0ef4e02/clone \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"sections":["ace20324-a0b9-11e8-98d0-529269fb1459"],"type":"STANDARD","questionnaireId":"0459f2ec-06e2-43c1-881e-9aeb3a50c1cd","name":"Cerner Demo Questionnaire 2020"}

{
  "clonedQuestionnaireDefinition": {
    "id": "ace20324-a0b9-11e8-98d0-529269fb1459"
  }
}

POST /questionnaire-definitions/{questionnaireDefinitionId}/clone

Clone existing questionnaire resources based on the Questionnaire definition ID and the list of section IDs. The following resources will be cloned: questionnaire-definition, sections, subsections, and questions. NOTE: Only the sections, subsections, and questions associated with the provided section IDs will be cloned.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
questionnaireDefinitionId	path	string	true	N/A	The ID of the Questionnaire definition to clone.	-
body	body	postQuestionnaireDefinitionsQuestionnairedefinitionidClone	true	N/A	No description	-

Response Statuses

Status	Meaning	Description	Schema
201	Created	Created	ConsumerEngagementPublicApi_Entities_V1_Questionnaires_QuestionnaireClone
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Retrieve a List of Questionnaire Response Definitions


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/questionnaire-response-definitions', headers: headers)

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "e3e44e50-5c65-11e9-8647-d663bd873d93",
      "authoredAt": "2018-07-16T19:20:00+01:00",
      "publishedQuestionnaire": {
        "id": "6091627d-b20b-4c1e-81e4-3d3ae9c7580e",
        "name": "Cerner Demo Questionnaire 2019"
      },
      "consumer": {
        "id": "08f464c0-4ce1-4cec-8e3c-9107ea17a1d7"
      },
      "completedQuestionnaireResponses": [
        {
          "id": "cf98baee-c461-11e9-aa8c-2a2ae2dbcce4",
          "authoredAt": "2018-07-16T19:20:00+01:00"
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/questionnaire-response-definitions?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/questionnaire-response-definitions?offset=0&limit=20"
}

GET /questionnaire-response-definitions

Retrieves a list of all the available Questionnaire Response Definitions.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
publishedQuestionnaireId	query	string	false	N/A	Filters by the ID of a published questionnaire.	-
consumerId	query	string	false	N/A	Filters by the ID of a Health Data Intelligence consumer.	-
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.	QuestionnaireResponseDefinitions
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a Questionnaire Response Definition




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/questionnaire-response-definitions', headers: headers, body: {"authoredAt":"2018-07-16T19:20:00+01:00","consumer":{"id":"08f464c0-4ce1-4cec-8e3c-9107ea17a1d7"},"publishedQuestionnaire":{"id":"6091627d-b20b-4c1e-81e4-3d3ae9c7580e","name":"Cerner Demo Questionnaire 2019"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/questionnaire-response-definitions \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"authoredAt":"2018-07-16T19:20:00+01:00","consumer":{"id":"08f464c0-4ce1-4cec-8e3c-9107ea17a1d7"},"publishedQuestionnaire":{"id":"6091627d-b20b-4c1e-81e4-3d3ae9c7580e","name":"Cerner Demo Questionnaire 2019"}}

{
  "id": "e3e44e50-5c65-11e9-8647-d663bd873d93",
  "authoredAt": "2018-07-16T19:20:00+01:00",
  "publishedQuestionnaire": {
    "id": "6091627d-b20b-4c1e-81e4-3d3ae9c7580e",
    "name": "Cerner Demo Questionnaire 2019"
  },
  "consumer": {
    "id": "08f464c0-4ce1-4cec-8e3c-9107ea17a1d7"
  },
  "completedQuestionnaireResponses": [
    {
      "id": "cf98baee-c461-11e9-aa8c-2a2ae2dbcce4",
      "authoredAt": "2018-07-16T19:20:00+01:00"
    }
  ]
}

POST /questionnaire-response-definitions

Creates a new Questionnaire response definition. A Questionnaire Response Definition stores metadata for a Questionnaire Response. Questionnaire Response Sections, Questionnaire Response Subsections, and Questionnaire Answers are all scoped to a Questionnaire Response Definition. The Questionnaire Response Definition may be changed at anytime but it will not affect a Completed Questionnaire Response. The Questionnaire Response Definition does not represent a complete Questionnaire Response.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
201	Created	Created	ConsumerEngagementPublicApi_Entities_V1_Questionnaires_QuestionnaireResponseDefinition
400	Bad Request	Bad Request. The response includes error details with a reason field that can help identify the issue. The following reasons are possible, among others: - `QuestionnaireDefinitionNotFound` The Questionnaire definition specified for the response does not exist.	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Delete a Questionnaire Response Definition


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/consumer-engagement/v1/questionnaire-response-definitions/e3e44e50-5c65-11e9-8647-d663bd873d93', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/questionnaire-response-definitions/e3e44e50-5c65-11e9-8647-d663bd873d93 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /questionnaire-response-definitions/{questionnaireResponseDefinitionId}

Deletes a Questionnaire response definition.

Parameters

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

Response Statuses

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

Update a Questionnaire Response Definition




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

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

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/questionnaire-response-definitions/e3e44e50-5c65-11e9-8647-d663bd873d93', headers: headers, body: {"authoredAt":"2018-07-16T19:20:00+01:00","consumer":{"id":"08f464c0-4ce1-4cec-8e3c-9107ea17a1d7"},"publishedQuestionnaire":{"id":"6091627d-b20b-4c1e-81e4-3d3ae9c7580e","name":"Cerner Demo Questionnaire 2019"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/questionnaire-response-definitions/e3e44e50-5c65-11e9-8647-d663bd873d93 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"authoredAt":"2018-07-16T19:20:00+01:00","consumer":{"id":"08f464c0-4ce1-4cec-8e3c-9107ea17a1d7"},"publishedQuestionnaire":{"id":"6091627d-b20b-4c1e-81e4-3d3ae9c7580e","name":"Cerner Demo Questionnaire 2019"}}

PUT /questionnaire-response-definitions/{questionnaireResponseDefinitionId}

Updates a Questionnaire response definition.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
questionnaireResponseDefinitionId	path	string	true	N/A	The ID of the questionniare response definition.	-
body	body	putQuestionnaireResponseDefinitions	true	N/A	No description	-

Response Statuses

Status	Meaning	Description	Schema
204	No Content	Updated	None
400	Bad Request	Bad Request. The response includes error details with a reason field that can help identify the issue. The following reasons are possible, among others: - `QuestionnaireDefinitionNotFound` The Questionnaire definition specified for the response does not exist.	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Retrieve a Single Questionnaire Response Definition


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/questionnaire-response-definitions/e3e44e50-5c65-11e9-8647-d663bd873d93', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/questionnaire-response-definitions/e3e44e50-5c65-11e9-8647-d663bd873d93 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "e3e44e50-5c65-11e9-8647-d663bd873d93",
  "authoredAt": "2018-07-16T19:20:00+01:00",
  "publishedQuestionnaire": {
    "id": "6091627d-b20b-4c1e-81e4-3d3ae9c7580e",
    "name": "Cerner Demo Questionnaire 2019"
  },
  "consumer": {
    "id": "08f464c0-4ce1-4cec-8e3c-9107ea17a1d7"
  },
  "completedQuestionnaireResponses": [
    {
      "id": "cf98baee-c461-11e9-aa8c-2a2ae2dbcce4",
      "authoredAt": "2018-07-16T19:20:00+01:00"
    }
  ]
}

GET /questionnaire-response-definitions/{questionnaireResponseDefinitionId}

Retrieves a single Questionnaire response definition.

Parameters

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

Response Statuses

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

Retrieve a List of Questionnaire Response Sections


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/consumer-engagement/v1/questionnaire-response-definitions/e3e44e50-5c65-11e9-8647-d663bd873d93/response-sections', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/questionnaire-response-definitions/e3e44e50-5c65-11e9-8647-d663bd873d93/response-sections \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "9a7bdd28-5c65-11e9-8647-d663bd873d93",
      "section": {
        "id": "12345678-120b-4c1e-81e4-3d3ae9c7580e"
      },
      "status": "COMPLETED",
      "answers": [
        {
          "id": "ace20324-a0b9-11e8-98d0-529269fb1459",
          "question": {
            "id": "12865678-120b-4c1e-81e4-3d3ae9c7580e"
          },
          "values": [
            {
              "option": {
                "id": "12865678-120b-4c1e-81e4-3d3ae9c7580e"
              },
              "value": "3"
            }
          ]
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/questionnaire-response-definitions/e3e44e50-5c65-11e9-8647-d663bd873d93/response-sections?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/questionnaire-response-definitions/e3e44e50-5c65-11e9-8647-d663bd873d93/response-sections?offset=0&limit=20"
}

GET /questionnaire-response-definitions/{questionnaireResponseDefinitionId}/response-sections

Retrieves a list of all of the available Questionnaire response sections.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
questionnaireResponseDefinitionId	path	string	true	N/A	The ID of the questionniare response 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	QuestionnaireResponseSections
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a Questionnaire Response Section




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/consumer-engagement/v1/questionnaire-response-definitions/e3e44e50-5c65-11e9-8647-d663bd873d93/response-sections', headers: headers, body: {"status":"COMPLETED","section":{"id":"12345678-120b-4c1e-81e4-3d3ae9c7580e"},"answers":[{"id":"ace20324-a0b9-11e8-98d0-529269fb1459","question":{"id":"12865678-120b-4c1e-81e4-3d3ae9c7580e"},"values":[{"option":{"id":"12865678-120b-4c1e-81e4-3d3ae9c7580e"},"value":"3"}]}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/questionnaire-response-definitions/e3e44e50-5c65-11e9-8647-d663bd873d93/response-sections \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"status":"COMPLETED","section":{"id":"12345678-120b-4c1e-81e4-3d3ae9c7580e"},"answers":[{"id":"ace20324-a0b9-11e8-98d0-529269fb1459","question":{"id":"12865678-120b-4c1e-81e4-3d3ae9c7580e"},"values":[{"option":{"id":"12865678-120b-4c1e-81e4-3d3ae9c7580e"},"value":"3"}]}]}

{
  "questionnaireResponseSections": [
    {
      "id": "9a7bdd28-5c65-11e9-8647-d663bd873d93",
      "section": {
        "id": "12345678-120b-4c1e-81e4-3d3ae9c7580e"
      },
      "status": "COMPLETED",
      "answers": [
        {
          "id": "ace20324-a0b9-11e8-98d0-529269fb1459",
          "question": {
            "id": "12865678-120b-4c1e-81e4-3d3ae9c7580e"
          },
          "values": [
            {
              "option": {
                "id": "12865678-120b-4c1e-81e4-3d3ae9c7580e"
              },
              "value": "3"
            }
          ]
        }
      ]
    }
  ]
}

POST /questionnaire-response-definitions/{questionnaireResponseDefinitionId}/response-sections

Creates a new Questionnaire response section for a Questionnaire response. A Questionnaire response section is a structured group that contains answers to questions in a particular section of a Questionnaire.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
questionnaireResponseDefinitionId	path	string	true	N/A	The ID of the questionniare response definition.	-
body	body	postQuestionnaireResponseDefinitionsQuestionnaireresponsedefinitionidResponseSections	true	N/A	No description	-

Response Statuses

Status	Meaning	Description	Schema
201	Created	Created	ConsumerEngagementPublicApi_Entities_V1_Questionnaires_QuestionnaireResponseSectionGroup
400	Bad Request	Bad Request. The response includes error details with a reason field that can help identify the issue. The following reasons are possible, among others: - `QuestionnaireSectionNotFound` The Questionnaire section specified for the response section does not exist. - `QuestionnaireQuestionNotFound` The Questionnaire question specified for the answer does not exist in the section. - `OptionNotFound` The option specified in the answer does not exist. - `InvalidValue` The value specified in the answer is not valid for the type of the question. - `ValueNotInRange` The value specified in the answer is not within the range specified by the question.	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Delete a Questionnaire Response Section


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/consumer-engagement/v1/questionnaire-response-definitions/e3e44e50-5c65-11e9-8647-d663bd873d93/response-sections/9a7bdd28-5c65-11e9-8647-d663bd873d93', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/questionnaire-response-definitions/e3e44e50-5c65-11e9-8647-d663bd873d93/response-sections/9a7bdd28-5c65-11e9-8647-d663bd873d93 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /questionnaire-response-definitions/{questionnaireResponseDefinitionId}/response-sections/{responseSectionId}

Deletes a Questionnaire response section for a Questionnaire response.

Parameters

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

Response Statuses

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

Update a Questionnaire Response Section




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/consumer-engagement/v1/questionnaire-response-definitions/e3e44e50-5c65-11e9-8647-d663bd873d93/response-sections/9a7bdd28-5c65-11e9-8647-d663bd873d93', headers: headers, body: {"status":"COMPLETED","section":{"id":"12345678-120b-4c1e-81e4-3d3ae9c7580e"},"answers":[{"id":"ace20324-a0b9-11e8-98d0-529269fb1459","question":{"id":"12865678-120b-4c1e-81e4-3d3ae9c7580e"},"values":[{"option":{"id":"12865678-120b-4c1e-81e4-3d3ae9c7580e"},"value":"3"}]}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/questionnaire-response-definitions/e3e44e50-5c65-11e9-8647-d663bd873d93/response-sections/9a7bdd28-5c65-11e9-8647-d663bd873d93 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"status":"COMPLETED","section":{"id":"12345678-120b-4c1e-81e4-3d3ae9c7580e"},"answers":[{"id":"ace20324-a0b9-11e8-98d0-529269fb1459","question":{"id":"12865678-120b-4c1e-81e4-3d3ae9c7580e"},"values":[{"option":{"id":"12865678-120b-4c1e-81e4-3d3ae9c7580e"},"value":"3"}]}]}

PUT /questionnaire-response-definitions/{questionnaireResponseDefinitionId}/response-sections/{responseSectionId}

Updates a Questionnaire response section for a Questionnaire response.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
questionnaireResponseDefinitionId	path	string	true	N/A	The ID of the questionniare response definition.	-
responseSectionId	path	string	true	N/A	The ID of the Questionnaire response section.	-
body	body	putQuestionnaireResponseDefinitionsQuestionnaireresponsedefinitionidResponseSections	true	N/A	No description	-

Response Statuses

Status	Meaning	Description	Schema
204	No Content	Updated	None
400	Bad Request	Bad Request. The response includes error details with a reason field that can help identify the issue. The following reasons are possible, among others: - `QuestionnaireSectionNotFound` The Questionnaire section specified for the response section does not exist. - `QuestionnaireQuestionNotFound` The Questionnaire question specified for the answer does not exist in the section. - `OptionNotFound` The option specified in the answer does not exist. - `InvalidValue` The value specified in the answer is not valid for the type of the question. - `ValueNotInRange` The value specified in the answer is not within the range specified by the question.	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Retrieve a Single Questionnaire Response Section


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/consumer-engagement/v1/questionnaire-response-definitions/e3e44e50-5c65-11e9-8647-d663bd873d93/response-sections/9a7bdd28-5c65-11e9-8647-d663bd873d93', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/questionnaire-response-definitions/e3e44e50-5c65-11e9-8647-d663bd873d93/response-sections/9a7bdd28-5c65-11e9-8647-d663bd873d93 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "9a7bdd28-5c65-11e9-8647-d663bd873d93",
  "section": {
    "id": "12345678-120b-4c1e-81e4-3d3ae9c7580e"
  },
  "status": "COMPLETED",
  "answers": [
    {
      "id": "ace20324-a0b9-11e8-98d0-529269fb1459",
      "question": {
        "id": "12865678-120b-4c1e-81e4-3d3ae9c7580e"
      },
      "values": [
        {
          "option": {
            "id": "12865678-120b-4c1e-81e4-3d3ae9c7580e"
          },
          "value": "3"
        }
      ]
    }
  ]
}

GET /questionnaire-response-definitions/{questionnaireResponseDefinitionId}/response-sections/{responseSectionId}

Retrieves a single Questionnaire response section for a Questionnaire response.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
questionnaireResponseDefinitionId	path	string	true	N/A	The ID of the questionniare response definition.	-
responseSectionId	path	string	true	N/A	The ID of the Questionnaire response section.	-

Response Statuses

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

Retrieve a List of questionnaire Response Subsections


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/consumer-engagement/v1/questionnaire-response-definitions/e3e44e50-5c65-11e9-8647-d663bd873d93/response-subsections', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/questionnaire-response-definitions/e3e44e50-5c65-11e9-8647-d663bd873d93/response-subsections \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "9a7be688-5c65-11e9-8647-d663bd873d93",
      "status": "COMPLETED",
      "subsection": {
        "id": "9a7be4e4-5c65-11e9-8647-d663bd873d93"
      },
      "answers": [
        {
          "id": "ace20324-a0b9-11e8-98d0-529269fb1459",
          "question": {
            "id": "12865678-120b-4c1e-81e4-3d3ae9c7580e"
          },
          "values": [
            {
              "option": {
                "id": "12865678-120b-4c1e-81e4-3d3ae9c7580e"
              },
              "value": "3"
            }
          ]
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/questionnaire-response-definitions/e3e44e50-5c65-11e9-8647-d663bd873d93/response-subsections?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/questionnaire-response-definitions/e3e44e50-5c65-11e9-8647-d663bd873d93/response-subsections?offset=0&limit=20"
}

GET /questionnaire-response-definitions/{questionnaireResponseDefinitionId}/response-subsections

Retrieves a list of all the available questionnaire response subsections for a questionnaire response.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
questionnaireResponseDefinitionId	path	string	true	N/A	The ID of the questionniare response 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.	QuestionnaireResponseSubsections
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a questionnaire Response Subsection




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/consumer-engagement/v1/questionnaire-response-definitions/e3e44e50-5c65-11e9-8647-d663bd873d93/response-subsections', headers: headers, body: {"subsection":{"id":"9a7be4e4-5c65-11e9-8647-d663bd873d93"},"status":"COMPLETED","answers":[{"id":"ace20324-a0b9-11e8-98d0-529269fb1459","question":{"id":"12865678-120b-4c1e-81e4-3d3ae9c7580e"},"values":[{"option":{"id":"12865678-120b-4c1e-81e4-3d3ae9c7580e"},"value":"3"}]}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/questionnaire-response-definitions/e3e44e50-5c65-11e9-8647-d663bd873d93/response-subsections \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"subsection":{"id":"9a7be4e4-5c65-11e9-8647-d663bd873d93"},"status":"COMPLETED","answers":[{"id":"ace20324-a0b9-11e8-98d0-529269fb1459","question":{"id":"12865678-120b-4c1e-81e4-3d3ae9c7580e"},"values":[{"option":{"id":"12865678-120b-4c1e-81e4-3d3ae9c7580e"},"value":"3"}]}]}

{
  "id": "9a7be688-5c65-11e9-8647-d663bd873d93",
  "status": "COMPLETED",
  "subsection": {
    "id": "9a7be4e4-5c65-11e9-8647-d663bd873d93"
  },
  "answers": [
    {
      "id": "ace20324-a0b9-11e8-98d0-529269fb1459",
      "question": {
        "id": "12865678-120b-4c1e-81e4-3d3ae9c7580e"
      },
      "values": [
        {
          "option": {
            "id": "12865678-120b-4c1e-81e4-3d3ae9c7580e"
          },
          "value": "3"
        }
      ]
    }
  ]
}

POST /questionnaire-response-definitions/{questionnaireResponseDefinitionId}/response-subsections

Creates a new questionnaire response subsection for a questionnaire response. A questionnaire response subsection is a structured group that contains answers to questions in a particular subsection of a questionnaire.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
questionnaireResponseDefinitionId	path	string	true	N/A	The ID of the questionniare response definition.	-
body	body	postQuestionnaireResponseDefinitionsQuestionnaireresponsedefinitionidResponseSubsections	true	N/A	No description	-

Response Statuses

Status	Meaning	Description	Schema
201	Created	Created	ConsumerEngagementPublicApi_Entities_V1_Questionnaires_QuestionnaireResponseSubsection
400	Bad Request	Bad Request. The response includes error details with a reason field that can help identify the issue. The following reasons are possible, among others: - `questionnaireSubsectionNotFound` The questionnaire subsection specified for the response subsection does not exist. - `questionnaireQuestionNotFound` The questionnaire question specified for the answer does not exist in the subsection. - `OptionNotFound` The option specified in the answer does not exist. - `InvalidValue` The value specified in the answer is not valid for the type of the question. - `ValueNotInRange` The value specified in the answer is not within the range specified by the question.	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Delete a questionnaire Response Subsection


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/consumer-engagement/v1/questionnaire-response-definitions/e3e44e50-5c65-11e9-8647-d663bd873d93/response-subsections/9a7bdd28-5c65-11e9-8647-d663bd873d93', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/questionnaire-response-definitions/e3e44e50-5c65-11e9-8647-d663bd873d93/response-subsections/9a7bdd28-5c65-11e9-8647-d663bd873d93 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /questionnaire-response-definitions/{questionnaireResponseDefinitionId}/response-subsections/{responseSubsectionId}

Deletes a questionnaire response subsection for a questionnaire response.

Parameters

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

Response Statuses

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

Update a questionnaire Response Subsection




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/consumer-engagement/v1/questionnaire-response-definitions/e3e44e50-5c65-11e9-8647-d663bd873d93/response-subsections/9a7bdd28-5c65-11e9-8647-d663bd873d93', headers: headers, body: {"subsection":{"id":"9a7be4e4-5c65-11e9-8647-d663bd873d93"},"status":"COMPLETED","answers":[{"id":"ace20324-a0b9-11e8-98d0-529269fb1459","question":{"id":"12865678-120b-4c1e-81e4-3d3ae9c7580e"},"values":[{"option":{"id":"12865678-120b-4c1e-81e4-3d3ae9c7580e"},"value":"3"}]}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/questionnaire-response-definitions/e3e44e50-5c65-11e9-8647-d663bd873d93/response-subsections/9a7bdd28-5c65-11e9-8647-d663bd873d93 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"subsection":{"id":"9a7be4e4-5c65-11e9-8647-d663bd873d93"},"status":"COMPLETED","answers":[{"id":"ace20324-a0b9-11e8-98d0-529269fb1459","question":{"id":"12865678-120b-4c1e-81e4-3d3ae9c7580e"},"values":[{"option":{"id":"12865678-120b-4c1e-81e4-3d3ae9c7580e"},"value":"3"}]}]}

PUT /questionnaire-response-definitions/{questionnaireResponseDefinitionId}/response-subsections/{responseSubsectionId}

Updates a questionnaire response subsection for a questionnaire response.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
questionnaireResponseDefinitionId	path	string	true	N/A	The ID of the questionniare response definition.	-
responseSubsectionId	path	string	true	N/A	The ID of the Questionnaire response subsection.	-
body	body	putQuestionnaireResponseDefinitionsQuestionnaireresponsedefinitionidResponseSubsections	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 questionnaire Response Subsection


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/consumer-engagement/v1/questionnaire-response-definitions/e3e44e50-5c65-11e9-8647-d663bd873d93/response-subsections/9a7bdd28-5c65-11e9-8647-d663bd873d93', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/questionnaire-response-definitions/e3e44e50-5c65-11e9-8647-d663bd873d93/response-subsections/9a7bdd28-5c65-11e9-8647-d663bd873d93 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "9a7be688-5c65-11e9-8647-d663bd873d93",
  "status": "COMPLETED",
  "subsection": {
    "id": "9a7be4e4-5c65-11e9-8647-d663bd873d93"
  },
  "answers": [
    {
      "id": "ace20324-a0b9-11e8-98d0-529269fb1459",
      "question": {
        "id": "12865678-120b-4c1e-81e4-3d3ae9c7580e"
      },
      "values": [
        {
          "option": {
            "id": "12865678-120b-4c1e-81e4-3d3ae9c7580e"
          },
          "value": "3"
        }
      ]
    }
  ]
}

GET /questionnaire-response-definitions/{questionnaireResponseDefinitionId}/response-subsections/{responseSubsectionId}

Retrieves a single questionnaire response subsection for a questionnaire response.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
questionnaireResponseDefinitionId	path	string	true	N/A	The ID of the questionniare response definition.	-
responseSubsectionId	path	string	true	N/A	The ID of the Questionnaire response subsection.	-

Response Statuses

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

Retrieve a List of Published Questionnaires


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/consumer-engagement/v1/published-questionnaires', headers: headers)

print JSON.pretty_generate(result)


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

{
  "id": "ace20324-a0b9-11e8-98d0-529269fb1459",
  "name": "Cerner Demo Questionnaire 2021",
  "type": "CAMPAIGN",
  "createdAt": "2021-02-09T17:11:24.000Z"
}

GET /published-questionnaires

Retrieves a list of all the available published questionnaires. A Published Questionnaire combines a Questionnaire Definition, Questionnaire Sections, Questionnaire Subsections, and Questionnaire Questions into a single resource. The Published Questionnaire is an immutable representation of a complete Questionnaire. The Published Questionnaire should be the resource that is referenced by external Services.

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.	-
orderBy	query	string	false	createdAt	A comma-separated list of fields by which to sort.	createdAt, -createdAt
type	query	array[string]	false	N/A	Filters by questionnaire types.	-

Response Statuses

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

Create a Published Questionnaire




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/consumer-engagement/v1/published-questionnaires', headers: headers, body: {"questionnaireDefinition":{"id":"e61dd2fa-702d-11e9-a923-1681be663d3e"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/published-questionnaires \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"questionnaireDefinition":{"id":"e61dd2fa-702d-11e9-a923-1681be663d3e"}}

{
  "id": "ace20324-a0b9-11e8-98d0-529269fb1459"
}

POST /published-questionnaires

Creates a new published questionnaire. A Published Questionnaire combines a Questionnaire Definition, Questionnaire Sections, Questionnaire Subsections, and Questionnaire Questions into a single resource. The Published Questionnaire is an immutable representation of a complete Questionnaire. The Published Questionnaire should be the resource that is referenced by external Services.

Parameters

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

Response Statuses

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

Retrieve a Single Published Questionnaire


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/consumer-engagement/v1/published-questionnaires/69c7f20d-a568-4bfd-ae0b-4475e0e2dd7f', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/published-questionnaires/69c7f20d-a568-4bfd-ae0b-4475e0e2dd7f \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "ace20324-a0b9-11e8-98d0-529269fb1459",
  "questionnaireDefinition": {
    "id": "e61dd2fa-702d-11e9-a923-1681be663d3e",
    "questionnaireId": "ace20324-a0b9-11e8-98d0-529269fb1459",
    "name": "Cerner Demo Questions Before You Start 2021",
    "type": "CAMPAIGN",
    "locale": "en-US",
    "description": "\\\"Cerner Demo Questions Before You Start 2021\\\" gathers general information from the consumer when they complete a `REGISTRATION WORKFLOW`.",
    "code": {
      "system": "urn:ietf:rfc:3986",
      "code": "2-16-840-1-113883-6-1",
      "display": "something that's not a Personal Health Assessment"
    },
    "sections": [
      {
        "id": "ace20324-a0b9-11e8-98d0-529269fb1459",
        "name": "Nutrition",
        "description": "The nutritional assessment is an evaluation of dietary intake and nutrition status to identify the presence of malnutrition, obesity, and so on.",
        "position": 1,
        "code": {
          "system": "urn:ietf:rfc:3986",
          "code": "2-16-840-1-113883-6-1",
          "display": "something that's not a Personal Health Assessment"
        },
        "questions": [
          {
            "id": "ace20324-a0b9-11e8-98d0-529269fb1459",
            "text": "How many times do you eat junk food in a week?",
            "type": "RANGE",
            "description": "Junk food is food that is highly processed; high in calories, sugars, salt, and trans fat; and low in nutrients.",
            "acceptsMultipleAnswers": true,
            "required": true,
            "position": 1,
            "section": {
              "id": "12345678-120b-4c1e-81e4-3d3ae9c7580e"
            },
            "subsection": {
              "id": "9a7be4e4-5c65-11e9-8647-d663bd873d93"
            },
            "code": {
              "system": "urn:ietf:rfc:3986",
              "code": "2-16-840-1-113883-6-1",
              "display": "something that's not a Personal Health Assessment"
            },
            "options": [
              {
                "id": "bce10324-a0b9-11e8-98d0-529269fb1459",
                "choice": {
                  "points": 5,
                  "text": "Between 1 and 25"
                },
                "range": {
                  "low": 1,
                  "high": 7,
                  "text": "Number of days in a week."
                }
              }
            ]
          }
        ],
        "subsections": [
          {
            "id": "9a7be7c8-5c65-11e9-8647-d663bd873d93",
            "name": "Nutrition-Fats",
            "description": "Nutrition-Fats is the subset of nutrition questions that evaluates fats in the diet of Health Data Intelligence consumers.",
            "position": 1,
            "code": {
              "system": "urn:ietf:rfc:3986",
              "code": "2-16-840-1-113883-6-1",
              "display": "something that's not a Personal Health Assessment"
            },
            "section": {
              "id": "12345678-120b-4c1e-81e4-3d3ae9c7580e"
            },
            "questions": [
              {
                "id": "ace20324-a0b9-11e8-98d0-529269fb1459",
                "text": "How many times do you eat junk food in a week?",
                "type": "RANGE",
                "description": "Junk food is food that is highly processed; high in calories, sugars, salt, and trans fat; and low in nutrients.",
                "acceptsMultipleAnswers": true,
                "required": true,
                "position": 1,
                "section": {
                  "id": "12345678-120b-4c1e-81e4-3d3ae9c7580e"
                },
                "subsection": {
                  "id": "9a7be4e4-5c65-11e9-8647-d663bd873d93"
                },
                "code": {
                  "system": "urn:ietf:rfc:3986",
                  "code": "2-16-840-1-113883-6-1",
                  "display": "something that's not a Personal Health Assessment"
                },
                "options": [
                  {
                    "id": "bce10324-a0b9-11e8-98d0-529269fb1459",
                    "choice": {
                      "points": 5,
                      "text": "Between 1 and 25"
                    },
                    "range": {
                      "low": 1,
                      "high": 7,
                      "text": "Number of days in a week."
                    }
                  }
                ]
              }
            ]
          }
        ]
      }
    ]
  }
}

GET /published-questionnaires/{publishedQuestionnaireId}

Retrieves a single published questionnaire. A Published Questionnaire combines a Questionnaire Definition, Questionnaire Sections, Questionnaire Subsections, and Questionnaire Questions into a single resource. The Published Questionnaire is an immutable representation of a complete Questionnaire. The Published Questionnaire should be the resource that is referenced by external Services.

Parameters

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

Response Statuses

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

Create a Completed Questionnaire Response




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/consumer-engagement/v1/completed-questionnaire-responses', headers: headers, body: {"questionnaireResponse":{"id":"e3e44e50-5c65-11e9-8647-d663bd873d93"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/completed-questionnaire-responses \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"questionnaireResponse":{"id":"e3e44e50-5c65-11e9-8647-d663bd873d93"}}

{
  "id": "a364d8d2-9da5-4188-aed2-252e81b4d976",
  "questionnaireResponseDefinition": {
    "id": "e3e44e50-5c65-11e9-8647-d663bd873d93"
  }
}

POST /completed-questionnaire-responses

Creates a new Completed Questionnaire Response. A Completed Questionnaire Response combines a Questionnaire Response Definition, Questionnaire Response Sections, Questionnaire Response Subsections, and Questionnaire Answers into a single resource. The Completed Questionnaire Response is an immutable representation of a complete Questionnaire Response. A Health Data Intelligence consumer can have multiple Completed Questionnaire Responses per Questionnaire.

Parameters

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

Response Statuses

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

Retrieve a single Completed Questionnaire Response


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/consumer-engagement/v1/completed-questionnaire-responses/a364d8d2-9da5-4188-aed2-252e81b4d976', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/completed-questionnaire-responses/a364d8d2-9da5-4188-aed2-252e81b4d976 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "a364d8d2-9da5-4188-aed2-252e81b4d976",
  "questionnaireResponseDefinition": {
    "id": "e3e44e50-5c65-11e9-8647-d663bd873d93"
  }
}

GET /completed-questionnaire-responses/{completedQuestionnaireResponseId}

Retrieves a single completed Questionnaire response. A Completed Questionnaire Response combines a Questionnaire Response Definition, Questionnaire Response Sections, Questionnaire Response Subsections, and Questionnaire Answers into a single resource. The Completed Questionnaire Response is an immutable representation of a complete Questionnaire Response. A Health Data Intelligence consumer can have multiple Completed Questionnaire Responses per Questionnaire.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
completedQuestionnaireResponseId	path	string	true	N/A	The ID of the completed Questionnaire response.	-

Response Statuses

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

Healthelife Messaging

A secure messaging system to allow communication between consumers and healthcare providers. Consumers can read and send messages with attachments and organize and move their messages in batch, in folders.

Retrieves a message attachment


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/consumer-engagement/v1/consumers/e61dd2fa-702d-11e9-a923-1681be663d3e/attachments',
  query: {
  'attachmentId' => 'string',
'domain' => 'string',
'version' => 'string'
}, headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/consumers/e61dd2fa-702d-11e9-a923-1681be663d3e/attachments?attachmentId=type,string&domain=type,string&version=type,string \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

GET /consumers/{consumerId}/attachments

Retrieves a message attachment.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
consumerId	path	string	true	N/A	The ID of the consumer.	-
attachmentId	query	string	true	N/A	The Millennium media identifier of a message attachment.	-
domain	query	string	true	N/A	The domain associated with the given tenant and consumer.	-
version	query	string	true	N/A	The version of the attachment being fetched.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	The binary string of a message attachment	None
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
404	Not Found	Not Found	Error

Uploads a new message attachment file




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/consumer-engagement/v1/consumers/e61dd2fa-702d-11e9-a923-1681be663d3e/attachments', headers: headers, body: {"domain":"demo.cernerdemo.healtheintent.com","media_content":"media_content.pdf","media_attributes":"media_attributes.json"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/consumers/e61dd2fa-702d-11e9-a923-1681be663d3e/attachments \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"domain":"demo.cernerdemo.healtheintent.com","media_content":"media_content.pdf","media_attributes":"media_attributes.json"}

{
  "id": "{17-c9-50-ae-ef-16-4a-46-a5-e1-c2-dd-9b-c6-b0-b9}",
  "version": "1",
  "attachmentName": "test_attachment.pdf",
  "contentType": "application/pdf",
  "patientId": "12560038"
}

POST /consumers/{consumerId}/attachments

Uploads a new message attachment file.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
consumerId	path	string	true	N/A	The ID of the consumer.	-
body	body	postConsumersConsumeridAttachments	true	N/A	No description	-

Response Statuses

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

Retrieves unread message counts for given patients


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/consumer-engagement/v1/consumers/{consumerId}/unread-message-counts',
  query: {
  'domain' => 'string',
'patientId' => 'array[string]'
}, headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/consumers/{consumerId}/unread-message-counts?domain=type,string&patientId=type,array,items,%5Bobject%20Object%5D \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "domain": "demo.cernerdemo.healtheintent.com",
      "unreadMessageCounts": {
        "patientId": "12560038",
        "unreadMessages": 10
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/unread-message-counts?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/unread-message-counts?offset=0&limit=20"
}

GET /consumers/{consumerId}/unread-message-counts

Retrieves unread message counts for given patients

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
domain	query	string	true	N/A	The domain to which the consumer belongs.	-
patientId	query	array[string]	true	N/A	One or more Millennium patient identifiers to fetch the unread message counts for.	-
consumerId	path	integer(int32)	true	N/A	No description	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	Success	UnreadMessageCounts
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error

Retrieve a Single Message


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/consumer-engagement/v1/consumers/e61dd2fa-702d-11e9-a923-1681be663d3e/messages/182863763:-4:0:0', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/consumers/e61dd2fa-702d-11e9-a923-1681be663d3e/messages/182863763:-4:0:0 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "millenniumMessageId": "182655763:-6:0:0",
  "domain": "demo.cernerdemo.wellness.healtheintent.com",
  "millenniumPreviousMessageId": "182655763",
  "patientId": "r745038c-470d-11ea-b77f-2e728ce88125",
  "senderId": "a045032c-470d-11ea-b77f-2e728ce88125",
  "senderType": "PERSON",
  "senderName": "Dr. Test Provider",
  "sentDate": "2021-03-05T16:07:41.000Z",
  "hasAttachment": true,
  "canReply": true,
  "recipients": [
    {
      "id": "13760354",
      "type": "PERSONNEL",
      "displayName": "Dr. Test Provider"
    }
  ],
  "ccRecipients": [
    {
      "id": "13760354",
      "type": "PERSONNEL",
      "displayName": "Dr. Test Provider"
    }
  ],
  "subject": "Recommendations For Joint Pain",
  "recipientMessageStatus": "UNREAD",
  "body": [
    {
      "formatType": "RTF",
      "text": "Here is a list of exercises and some instructions to perform them safely to better manage the joint pain."
    }
  ],
  "attachments": [
    {
      "name": "Exercises.pdf",
      "mediaIdentifier": "df-4b-1f-29-cd-27-41-4a-b5-16-5b-a6-d2-52-f8-f4",
      "mediaVersion": 1
    }
  ]
}

GET /consumers/{consumerId}/messages/{messageId}

Retrieves a single message by ID.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
consumerId	path	string	true	N/A	The ID of the consumer.	-
messageId	path	string	true	N/A	The Cerner Millennium ID of the message.	-

Response Statuses

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

Updates a Single Message




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/consumer-engagement/v1/consumers/e61dd2fa-702d-11e9-a923-1681be663d3e/messages/182863763:-4:0:0', headers: headers, body: {"status":"OPEN","domain":"demo.cernerdemo.wellness.healtheintent.com","patientId":"r745038c-470d-11ea-b77f-2e728ce88125"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/consumers/e61dd2fa-702d-11e9-a923-1681be663d3e/messages/182863763:-4:0:0 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"status":"OPEN","domain":"demo.cernerdemo.wellness.healtheintent.com","patientId":"r745038c-470d-11ea-b77f-2e728ce88125"}

PUT /consumers/{consumerId}/messages/{messageId}

Updates a single message by ID.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
consumerId	path	string	true	N/A	The ID of the consumer.	-
messageId	path	string	true	N/A	The Cerner Millennium ID of the message.	-
body	body	putConsumersConsumeridMessages	true	N/A	No description	-

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

Delete a Batch of Messages




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/consumer-engagement/v1/consumers/e61dd2fa-702d-11e9-a923-1681be663d3e/messages/batch-delete', headers: headers)

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/consumers/e61dd2fa-702d-11e9-a923-1681be663d3e/messages/batch-delete \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'

POST /consumers/{consumerId}/messages/batch-delete

Deletes a batch of messages. This action follows the principle of atomicity: If an error occurs while deleting any of the batch messages, no messages from the batch are deleted.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
consumerId	path	string	true	N/A	The ID of the consumer.	-
body	body	array[object]	true	N/A	The IDs of the messages to be deleted.	[object Object]

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

Modify a Batch of Messages




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/consumer-engagement/v1/consumers/e61dd2fa-702d-11e9-a923-1681be663d3e/messages/batch-modify', headers: headers, body: {"messages":[{"id":"d7d195c0-260b-4ec5-a330-52e0c3394052"},{"id":"1815953d-f85b-474b-8a63-52a920b3fe64"}],"consumerFolderId":"71ab3b27-ed82-43bf-838c-17a049ca0cf8"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/consumers/e61dd2fa-702d-11e9-a923-1681be663d3e/messages/batch-modify \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"messages":[{"id":"d7d195c0-260b-4ec5-a330-52e0c3394052"},{"id":"1815953d-f85b-474b-8a63-52a920b3fe64"}],"consumerFolderId":"71ab3b27-ed82-43bf-838c-17a049ca0cf8"}

POST /consumers/{consumerId}/messages/batch-modify

Modifies a batch of messages. This action follows the principle of atomicity: If an error occurs while modifying any of the messages in the batch, no changes are made for the entire batch.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
consumerId	path	string	true	N/A	The ID of the consumer.	-
body	body	postConsumersConsumeridMessagesBatchModify	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

Create a Message




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/consumer-engagement/v1/consumers/e61dd2fa-702d-11e9-a923-1681be663d3e/messages', headers: headers, body: {"domain":"demo.cernerdemo.wellness.healtheintent.com","patientId":"r745038c-470d-11ea-b77f-2e728ce88125","millenniumPreviousMessageId":"182655763","messageType":"APPOINTMENT_SCHEDULE","recipients":[{"id":"13760354","type":"PERSONNEL","displayName":"Dr. Test Provider"}],"subject":"Recommendations For Joint Pain","body":{"formatType":"RTF","text":"Here is a list of exercises and some instructions to perform them safely to better manage the joint pain."},"attachments":[{"name":"Exercises.pdf","mediaIdentifier":"df-4b-1f-29-cd-27-41-4a-b5-16-5b-a6-d2-52-f8-f4","mediaVersion":1}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/consumers/e61dd2fa-702d-11e9-a923-1681be663d3e/messages \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"domain":"demo.cernerdemo.wellness.healtheintent.com","patientId":"r745038c-470d-11ea-b77f-2e728ce88125","millenniumPreviousMessageId":"182655763","messageType":"APPOINTMENT_SCHEDULE","recipients":[{"id":"13760354","type":"PERSONNEL","displayName":"Dr. Test Provider"}],"subject":"Recommendations For Joint Pain","body":{"formatType":"RTF","text":"Here is a list of exercises and some instructions to perform them safely to better manage the joint pain."},"attachments":[{"name":"Exercises.pdf","mediaIdentifier":"df-4b-1f-29-cd-27-41-4a-b5-16-5b-a6-d2-52-f8-f4","mediaVersion":1}]}

{
  "millenniumMessageId": "182655763:-6:0:0",
  "domain": "demo.cernerdemo.wellness.healtheintent.com",
  "sentDate": "2021-03-05T16:07:41.000Z"
}

POST /consumers/{consumerId}/messages

Creates a new message.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
consumerId	path	string	true	N/A	The ID of the consumer.	-
body	body	postConsumersConsumeridMessages	true	N/A	No description	-

Response Statuses

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

Retrieve a List of Messages


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/consumer-engagement/v1/consumers/e61dd2fa-702d-11e9-a923-1681be663d3e/messages',
  query: {
  'folderId' => 'string',
'domain' => 'string'
}, headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/consumers/e61dd2fa-702d-11e9-a923-1681be663d3e/messages?folderId=type,string&domain=demo.cernerdemo.wellness.healtheintent.com \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "millenniumMessageId": "182655763:-6:0:0",
      "domain": "demo.cernerdemo.wellness.healtheintent.com",
      "millenniumPreviousMessageId": "182655763",
      "patientId": "r745038c-470d-11ea-b77f-2e728ce88125",
      "senderId": "a045032c-470d-11ea-b77f-2e728ce88125",
      "senderType": "PERSON",
      "senderName": "Dr. Test Provider",
      "sentDate": "2021-03-05T16:07:41.000Z",
      "hasAttachment": true,
      "canReply": true,
      "recipients": [
        {
          "id": "13760354",
          "type": "PERSONNEL",
          "displayName": "Dr. Test Provider"
        }
      ],
      "ccRecipients": [
        {
          "id": "13760354",
          "type": "PERSONNEL",
          "displayName": "Dr. Test Provider"
        }
      ],
      "subject": "Recommendations For Joint Pain",
      "recipientMessageStatus": "UNREAD",
      "body": [
        {
          "formatType": "RTF",
          "text": "Here is a list of exercises and some instructions to perform them safely to better manage the joint pain."
        }
      ],
      "attachments": [
        {
          "name": "Exercises.pdf",
          "mediaIdentifier": "df-4b-1f-29-cd-27-41-4a-b5-16-5b-a6-d2-52-f8-f4",
          "mediaVersion": 1
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/consumers/e61dd2fa-702d-11e9-a923-1681be663d3e/messages?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/consumers/e61dd2fa-702d-11e9-a923-1681be663d3e/messages?offset=0&limit=20"
}

GET /consumers/{consumerId}/messages

Retrieves a list of messages. Messages will be returned in descending order of the sent date.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
consumerId	path	string	true	N/A	The ID of the consumer.	-
folderId	query	string	true	N/A	ID of the consumer folder(s) from where messages are to be retrieved.	-
domain	query	string	true	N/A	The domain from the given tenant.	-
patientId	query	string	false	N/A	The ID of a patient.	-
authorizedPatientId	query	array[string]	false	N/A	The ID of authorized patient whose messages are to be retrieved.	-
status	query	string	false	N/A	Filters the retrieved messages by status.	UNREAD, OPENED, ONHOLD, DELETED, UNKNOWN
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	MessageDetails
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Delete a Folder


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/consumer-engagement/v1/consumers/e61dd2fa-702d-11e9-a923-1681be663d3e/folders/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/consumer-engagement/v1/consumers/e61dd2fa-702d-11e9-a923-1681be663d3e/folders/1a857d33-5b74-4c76-9a60-a008ea652cc6 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /consumers/{consumerId}/folders/{folderId}

Deletes a folder with a given ID. System reserved folders such as INBOX, SENT, and TRASH cannot be deleted.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
consumerId	path	string	true	N/A	The ID of a consumer.	-
folderId	path	string	true	N/A	The ID of the folder.	-

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 Folder




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/consumer-engagement/v1/consumers/e61dd2fa-702d-11e9-a923-1681be663d3e/folders/1a857d33-5b74-4c76-9a60-a008ea652cc6', headers: headers, body: {"name":"Custom Folder 1","domain":"demo.cernerdemo.healtheintent.com"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/consumers/e61dd2fa-702d-11e9-a923-1681be663d3e/folders/1a857d33-5b74-4c76-9a60-a008ea652cc6 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Custom Folder 1","domain":"demo.cernerdemo.healtheintent.com"}

PUT /consumers/{consumerId}/folders/{folderId}

Updates a folder with a given ID. System reserved folders such as INBOX, SENT, and TRASH cannot be updated.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
consumerId	path	string	true	N/A	The ID of a consumer.	-
folderId	path	string	true	N/A	The ID of the folder.	-
body	body	putConsumersConsumeridFolders	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 Folder


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/consumer-engagement/v1/consumers/e61dd2fa-702d-11e9-a923-1681be663d3e/folders/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/consumer-engagement/v1/consumers/e61dd2fa-702d-11e9-a923-1681be663d3e/folders/1a857d33-5b74-4c76-9a60-a008ea652cc6 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "ace20324-a0b9-11e8-98d0-529269fb1459",
  "consumerId": "a045032c-470d-11ea-b77f-2e728ce88125",
  "name": "Custom Folder 1",
  "domain": "demo.cernerdemo.healtheintent.com",
  "type": "CUSTOM",
  "createdAt": "2021-10-21T10:00:00.000Z",
  "updatedAt": "2021-10-21T10:00:00.000Z"
}

GET /consumers/{consumerId}/folders/{folderId}

Retrieves a single folder with a given ID.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
consumerId	path	string	true	N/A	The ID of a consumer.	-
folderId	path	string	true	N/A	The ID of the folder.	-

Response Statuses

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

Retrieve a List of Folders




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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/consumers/e61dd2fa-702d-11e9-a923-1681be663d3e/folders', headers: headers)

print JSON.pretty_generate(result)




# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/consumers/e61dd2fa-702d-11e9-a923-1681be663d3e/folders \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "ace20324-a0b9-11e8-98d0-529269fb1459",
      "consumerId": "a045032c-470d-11ea-b77f-2e728ce88125",
      "name": "Custom Folder 1",
      "domain": "demo.cernerdemo.healtheintent.com",
      "type": "CUSTOM",
      "createdAt": "2021-10-21T10:00:00.000Z",
      "updatedAt": "2021-10-21T10:00:00.000Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/consumers/e61dd2fa-702d-11e9-a923-1681be663d3e/folders?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/consumers/e61dd2fa-702d-11e9-a923-1681be663d3e/folders?offset=0&limit=20"
}

GET /consumers/{consumerId}/folders

Retrieves a list of folders for a given consumer.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
consumerId	path	string	true	N/A	The ID of a consumer.	-
type	query	string	false	N/A	The type of folder by which to filter the folders list.	INBOX, SENT, TRASH, PERMANENT_DELETE, CUSTOM
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.	-
body	body	string	true	N/A	The domain or location associated with the tenant	-

Response Statuses

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

Create a Folder




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/consumer-engagement/v1/consumers/e61dd2fa-702d-11e9-a923-1681be663d3e/folders', headers: headers, body: {"name":"Custom Folder 1","domain":"demo.cernerdemo.healtheintent.com"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/consumers/e61dd2fa-702d-11e9-a923-1681be663d3e/folders \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Custom Folder 1","domain":"demo.cernerdemo.healtheintent.com"}

{
  "id": "ace20324-a0b9-11e8-98d0-529269fb1459",
  "consumerId": "a045032c-470d-11ea-b77f-2e728ce88125",
  "name": "Custom Folder 1",
  "domain": "demo.cernerdemo.healtheintent.com",
  "type": "CUSTOM",
  "createdAt": "2021-10-21T10:00:00.000Z",
  "updatedAt": "2021-10-21T10:00:00.000Z"
}

POST /consumers/{consumerId}/folders

Creates a new folder. A folder cannot be created with system reserved names such as INBOX, SENT, and TRASH.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
consumerId	path	string	true	N/A	The ID of a consumer.	-
body	body	postConsumersConsumeridFolders	true	N/A	No description	-

Response Statuses

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

Retrieves a List of Routing Rules


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/consumer-engagement/v1/routing-rules', headers: headers)

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "40356955-6720-73ac-9224-8b713cc67a5d",
      "domain": "demo.cernerdemo.healtheintent.com",
      "messageType": "APPOINTMENT_SCHEDULE",
      "intendedPersonnel": {
        "id": "22c25e2c-75cd-4e2b-b8f1-759893d7d79b",
        "millenniumId": "13826354",
        "displayName": "Dr. Bob Jones"
      },
      "routedPersonnel": {
        "id": "22c25e2c-75cd-4e2b-b8f1-759893d7d79b",
        "millenniumId": "13826354",
        "displayName": "Dr. Bob Jones"
      },
      "intendedPool": {
        "id": "a3602e55-e79a-4b29-8871-e00b041be345",
        "millenniumId": "12560038",
        "displayName": "Care team of Dr. Bob Jones"
      },
      "routedPool": {
        "id": "a3602e55-e79a-4b29-8871-e00b041be345",
        "millenniumId": "12560038",
        "displayName": "Care team of Dr. Bob Jones"
      },
      "createdAt": "2021-11-01T10:00:00.000Z",
      "updatedAt": "2021-11-07T10:00:00.000Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/routing-rules?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/routing-rules?offset=0&limit=20"
}

GET /routing-rules

Retrieves a list of routing rules.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
domain	query	string	false	N/A	The domain with which the routing rule is associated.	-
messageType	query	string	false	N/A	Message types are pre-defined keys to describe what type of message the consumer is sending to the recipient. Supported message types are GENERAL, APPOINTMENT_SCHEDULE, APPOINTMENT_RESCHEDULE, APPOINTMENT_CANCEL, MEDICATION_REFILL, PRESCRIPTION_RENEWAL, PATIENT_INFORMATION.	-
intendedDisplay	query	string	false	N/A	The full or partial display name of the intended personnel or pool to query the routing rules by.	-
routedDisplay	query	string	false	N/A	The full or partial display name of the routed personnel or pool to query the routing rules by.	-
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	RoutingRules
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error

Creates a Routing Rule




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/consumer-engagement/v1/routing-rules', headers: headers, body: {"domain":"demo.cernerdemo.healtheintent.com","messageType":"APPOINTMENT_SCHEDULE","intendedPoolId":"f870b2c7-49c3-4ef6-8fe3-eec2307a036b","routedPersonnelId":"5d4aa2c1-48d3-4307-a0eb-b7581f8120af","routedPoolId":"f870b2c7-49c3-4ef6-8fe3-eec2307a036b"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/routing-rules \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"domain":"demo.cernerdemo.healtheintent.com","messageType":"APPOINTMENT_SCHEDULE","intendedPoolId":"f870b2c7-49c3-4ef6-8fe3-eec2307a036b","routedPersonnelId":"5d4aa2c1-48d3-4307-a0eb-b7581f8120af","routedPoolId":"f870b2c7-49c3-4ef6-8fe3-eec2307a036b"}

{
  "id": "40356955-6720-73ac-9224-8b713cc67a5d",
  "domain": "demo.cernerdemo.healtheintent.com",
  "messageType": "APPOINTMENT_SCHEDULE",
  "intendedPersonnel": {
    "id": "22c25e2c-75cd-4e2b-b8f1-759893d7d79b",
    "millenniumId": "13826354",
    "displayName": "Dr. Bob Jones"
  },
  "routedPersonnel": {
    "id": "22c25e2c-75cd-4e2b-b8f1-759893d7d79b",
    "millenniumId": "13826354",
    "displayName": "Dr. Bob Jones"
  },
  "intendedPool": {
    "id": "a3602e55-e79a-4b29-8871-e00b041be345",
    "millenniumId": "12560038",
    "displayName": "Care team of Dr. Bob Jones"
  },
  "routedPool": {
    "id": "a3602e55-e79a-4b29-8871-e00b041be345",
    "millenniumId": "12560038",
    "displayName": "Care team of Dr. Bob Jones"
  },
  "createdAt": "2021-11-01T10:00:00.000Z",
  "updatedAt": "2021-11-07T10:00:00.000Z"
}

POST /routing-rules

Creates routing rules using specified parameters. Routing rules define where messages are routed when a consumer sends a message to their provider. Administrators of the site can configure rules such that messages sent by consumers can be sent to a pool or personnel.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
201	Created	Created	ConsumerEngagementPublicApi_Entities_V1_HealthelifeMessaging_RoutingRule
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error

Deletes a Routing Rule


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/consumer-engagement/v1/routing-rules/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/consumer-engagement/v1/routing-rules/1a857d33-5b74-4c76-9a60-a008ea652cc6 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /routing-rules/{routingRuleId}

Deletes a single routing rule by ID.

Parameters

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

Response Statuses

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

Updates a Routing Rule




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/consumer-engagement/v1/routing-rules/1a857d33-5b74-4c76-9a60-a008ea652cc6', headers: headers, body: {"routedPersonnelId":"5d4aa2c1-48d3-4307-a0eb-b7581f8120af","routedPoolId":"f870b2c7-49c3-4ef6-8fe3-eec2307a036b"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/routing-rules/1a857d33-5b74-4c76-9a60-a008ea652cc6 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"routedPersonnelId":"5d4aa2c1-48d3-4307-a0eb-b7581f8120af","routedPoolId":"f870b2c7-49c3-4ef6-8fe3-eec2307a036b"}

PUT /routing-rules/{routingRuleId}

Updates a single routing rule by ID.

Parameters

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

Response Statuses

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

Retrieves a Single Routing Rule


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/consumer-engagement/v1/routing-rules/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/consumer-engagement/v1/routing-rules/1a857d33-5b74-4c76-9a60-a008ea652cc6 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "40356955-6720-73ac-9224-8b713cc67a5d",
  "domain": "demo.cernerdemo.healtheintent.com",
  "messageType": "APPOINTMENT_SCHEDULE",
  "intendedPersonnel": {
    "id": "22c25e2c-75cd-4e2b-b8f1-759893d7d79b",
    "millenniumId": "13826354",
    "displayName": "Dr. Bob Jones"
  },
  "routedPersonnel": {
    "id": "22c25e2c-75cd-4e2b-b8f1-759893d7d79b",
    "millenniumId": "13826354",
    "displayName": "Dr. Bob Jones"
  },
  "intendedPool": {
    "id": "a3602e55-e79a-4b29-8871-e00b041be345",
    "millenniumId": "12560038",
    "displayName": "Care team of Dr. Bob Jones"
  },
  "routedPool": {
    "id": "a3602e55-e79a-4b29-8871-e00b041be345",
    "millenniumId": "12560038",
    "displayName": "Care team of Dr. Bob Jones"
  },
  "createdAt": "2021-11-01T10:00:00.000Z",
  "updatedAt": "2021-11-07T10:00:00.000Z"
}

GET /routing-rules/{routingRuleId}

Retrieves a single routing rule by ID.

Parameters

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

Response Statuses

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

Creates/updates multiple routing rules




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/consumer-engagement/v1/routing-rules/batch-upsert', headers: headers, body: {"domain":"portaleng.patientportal.us.healtheintent.com","routing_rules_file":"routing_rules_file.csv"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/routing-rules/batch-upsert \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"domain":"portaleng.patientportal.us.healtheintent.com","routing_rules_file":"routing_rules_file.csv"}

{
  "routingRulesFound": "50",
  "routingRulesCreated": "20",
  "routingRulesUpdated": "30",
  "errorDetails": [
    {
      "line": "50",
      "messages": [
        "Millennium name can't be blank"
      ]
    }
  ]
}

POST /routing-rules/batch-upsert

Creates/Updates routing rules using data from a CSV file. Each line of the CSV file corresponds to one routing rule. Routing rules are created or updated as follows -

If a routing rule with the specified messageType, intendedType, and intendedAlias*currently exists* for the tenantId and domain, its routedPoolId/routedPersonnelId field is updated according to the routedToType and routedToAlias specified in the file

If a routing rule with the specified messageType, intendedType, and intendedAliascurrently exists for the tenantId and domain, a new routing rule is created.

The CSV file must contain the following columns -

MESSAGE_TYPE

INTENDED_TYPE

INTENDED_DISPLAY_NAME

INTENDED_ALIAS

ROUTED_TO_TYPE

ROUTED_TO_DISPLAY_NAME

ROUTED_TO_ALIAS

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
200	OK	No Content	ConsumerEngagementPublicApi_Entities_V1_HealthelifeMessaging_BatchUpsertRoutingRuleResponse
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Retrieves a List of Messaging 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/consumer-engagement/v1/messaging-configs', headers: headers)

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "40356955-6720-73ac-9224-8b713cc67a5d",
      "domain": "demo.cernerdemo.healtheintent.com",
      "messagingEnabled": true,
      "preDefinedSubjectEnabled": true,
      "attachmentsEnabled": true,
      "addRecipientInSubject": true,
      "sensitiveMessaging": true,
      "relationshipBasedMessaging": true,
      "locale": "en-US",
      "createdAt": "2021-11-01T10:00:00.000Z",
      "updatedAt": "2021-11-07T10:00:00.000Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/messaging-configs?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/messaging-configs?offset=0&limit=20"
}

GET /messaging-configs

Retrieves a list of messaging configurations.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
domain	query	string	false	N/A	The domain with which the messaging configuration is associated.	-
messagingEnabled	query	boolean	false	N/A	The configuration to denote whether the messaging feature is enabled for this domain.	-
preDefinedSubjectEnabled	query	boolean	false	N/A	The configuration to denote whether the pre-defined subject is enabled for this domain.	-
attachmentsEnabled	query	boolean	false	N/A	The configuration to denote whether the attachments are supported for messages.	-
sensitiveMessaging	query	boolean	false	N/A	The configuration to denote whether the portal users while sending the message can select who else from their list of authorized users will have access to this message.	-
relationshipBasedMessaging	query	boolean	false	N/A	The configuration to denote whether the portal users can send new messages only to messageable providers with whom they have established either person-level or encounter-level relationships.	-
locale	query	string	false	N/A	The locale with which this messaging configuration is associated.	-
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	MessagingConfigs
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error

Creates a Messaging 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/consumer-engagement/v1/messaging-configs', headers: headers, body: {"domain":"demo.cernerdemo.healtheintent.com","locale":"en-US","messagingEnabled":true,"preDefinedSubjectEnabled":true,"attachmentsEnabled":true,"addRecipientInSubject":true,"sensitiveMessaging":true,"relationshipBasedMessaging":true}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/messaging-configs \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"domain":"demo.cernerdemo.healtheintent.com","locale":"en-US","messagingEnabled":true,"preDefinedSubjectEnabled":true,"attachmentsEnabled":true,"addRecipientInSubject":true,"sensitiveMessaging":true,"relationshipBasedMessaging":true}

{
  "id": "40356955-6720-73ac-9224-8b713cc67a5d",
  "domain": "demo.cernerdemo.healtheintent.com",
  "messagingEnabled": true,
  "preDefinedSubjectEnabled": true,
  "attachmentsEnabled": true,
  "addRecipientInSubject": true,
  "sensitiveMessaging": true,
  "relationshipBasedMessaging": true,
  "locale": "en-US",
  "createdAt": "2021-11-01T10:00:00.000Z",
  "updatedAt": "2021-11-07T10:00:00.000Z"
}

POST /messaging-configs

Creates messaging configuration using specified parameters.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
201	Created	Created	ConsumerEngagementPublicApi_Entities_V1_HealthelifeMessaging_MessagingConfig
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error

Deletes a Single Messaging Configuration by ID


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/consumer-engagement/v1/messaging-configs/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/consumer-engagement/v1/messaging-configs/1a857d33-5b74-4c76-9a60-a008ea652cc6 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /messaging-configs/{messagingConfigId}

Deletes a single messaging configuration by ID.

Parameters

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

Response Statuses

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

Updates a Single Messaging 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/consumer-engagement/v1/messaging-configs/1a857d33-5b74-4c76-9a60-a008ea652cc6', headers: headers, body: {"domain":"demo.cernerdemo.healtheintent.com","locale":"en-US","messagingEnabled":true,"preDefinedSubjectEnabled":true,"attachmentsEnabled":true,"addRecipientInSubject":true,"sensitiveMessaging":true,"relationshipBasedMessaging":true}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/messaging-configs/1a857d33-5b74-4c76-9a60-a008ea652cc6 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"domain":"demo.cernerdemo.healtheintent.com","locale":"en-US","messagingEnabled":true,"preDefinedSubjectEnabled":true,"attachmentsEnabled":true,"addRecipientInSubject":true,"sensitiveMessaging":true,"relationshipBasedMessaging":true}

PUT /messaging-configs/{messagingConfigId}

Updates a single messaging configuration by ID.

Parameters

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

Response Statuses

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

Retrieves a Single Messaging 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/consumer-engagement/v1/messaging-configs/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/consumer-engagement/v1/messaging-configs/1a857d33-5b74-4c76-9a60-a008ea652cc6 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "40356955-6720-73ac-9224-8b713cc67a5d",
  "domain": "demo.cernerdemo.healtheintent.com",
  "messagingEnabled": true,
  "preDefinedSubjectEnabled": true,
  "attachmentsEnabled": true,
  "addRecipientInSubject": true,
  "sensitiveMessaging": true,
  "relationshipBasedMessaging": true,
  "locale": "en-US",
  "createdAt": "2021-11-01T10:00:00.000Z",
  "updatedAt": "2021-11-07T10:00:00.000Z"
}

GET /messaging-configs/{messagingConfigId}

Retrieves a single messaging configuration by ID.

Parameters

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

Response Statuses

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

Retrieves a List of Pools


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/consumer-engagement/v1/pools', headers: headers)

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "40356955-6720-73ac-9224-8b713cc67a5d",
      "domain": "demo.cernerdemo.healtheintent.com",
      "millenniumPoolId": "5d4aa2c1-48d3-4307-a0eb-b7581f8120af",
      "millenniumName": "Cerner Millennium Pool Name for Dr. Providers Care Team",
      "displayName": "Dr. Test Providers Care Team (Innovations)",
      "isMessageable": true,
      "createdAt": "2022-02-01T10:00:00.000Z",
      "updatedAt": "2021-02-07T10:00:00.000Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/pools?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/pools?offset=0&limit=20"
}

GET /pools

Retrieves a list of pools.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
domain	query	string	false	N/A	The domain with which a pool is associated, and by which to filter the list of results.	-
displayName	query	string	false	N/A	The name of a pool in HealtheLife Messaging by which to filter the list of results.	-
isMessageable	query	boolean	false	N/A	When true, returns pools that are currently messageable by patients.	-
millenniumPoolId	query	array[string]	false	N/A	One or more Cerner Millennium millenniumPoolIds by which to filter the list of results.	-
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	Pools
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error

Updates a Pool




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/consumer-engagement/v1/pools/1a857d33-5b74-4c76-9a60-a008ea652cc6', headers: headers, body: {"domain":"demo.cernerdemo.healtheintent.com","millenniumPoolId":"587634012","displayName":"Dr. Bob Smiths Care Team (Innovations)"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/pools/1a857d33-5b74-4c76-9a60-a008ea652cc6 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"domain":"demo.cernerdemo.healtheintent.com","millenniumPoolId":"587634012","displayName":"Dr. Bob Smiths Care Team (Innovations)"}

PUT /pools/{id}

Updates a single pool by ID.

Parameters

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

Response Statuses

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

Retrieves a Single Pool


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/consumer-engagement/v1/pools/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/consumer-engagement/v1/pools/1a857d33-5b74-4c76-9a60-a008ea652cc6 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "40356955-6720-73ac-9224-8b713cc67a5d",
  "domain": "demo.cernerdemo.healtheintent.com",
  "millenniumPoolId": "5d4aa2c1-48d3-4307-a0eb-b7581f8120af",
  "millenniumName": "Cerner Millennium Pool Name for Dr. Providers Care Team",
  "displayName": "Dr. Test Providers Care Team (Innovations)",
  "isMessageable": true,
  "createdAt": "2022-02-01T10:00:00.000Z",
  "updatedAt": "2021-02-07T10:00:00.000Z"
}

GET /pools/{id}

Retrieves a single pool by ID.

Parameters

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

Response Statuses

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

Retrieves a List of Personnel


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/consumer-engagement/v1/personnels', headers: headers)

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "40356955-6720-73ac-9224-8b713cc67a5d",
      "domain": "demo.cernerdemo.healtheintent.com",
      "millenniumPersonnelId": "823456234",
      "millenniumName": "Dr. Jebediah Springfield",
      "displayName": "Dr. Jebediah Springfield",
      "isMessageable": true,
      "personnelAlias": "8340861319",
      "createdAt": "2022-02-01T10:00:00.000Z",
      "updatedAt": "2021-02-07T10:00:00.000Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/personnels?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/personnels?offset=0&limit=20"
}

GET /personnels

Retrieves a list of personnel.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
domain	query	string	false	N/A	The domain with which a personnel is associated, and by which to filter the list of results.	-
displayName	query	string	false	N/A	The name of a personnel in HealtheLife Messaging, and by which to filter the list of results.	-
isMessageable	query	boolean	false	N/A	When true, returns personnel that are currently messageable by patients.	-
millenniumPersonnelId	query	array[string]	false	N/A	One or more Cerner Millennium millenniumPersonnelIds by which to filter the list of results.	-
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	Personnels
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error

Create a Personnel




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/consumer-engagement/v1/personnels', headers: headers, body: {"domain":"demo.cernerdemo.healtheintent.com","millenniumPersonnelId":"42347421","displayName":"Dr. Jebediah Springfield"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/personnels \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"domain":"demo.cernerdemo.healtheintent.com","millenniumPersonnelId":"42347421","displayName":"Dr. Jebediah Springfield"}

{
  "id": "40356955-6720-73ac-9224-8b713cc67a5d",
  "domain": "demo.cernerdemo.healtheintent.com",
  "millenniumPersonnelId": "823456234",
  "millenniumName": "Dr. Jebediah Springfield",
  "displayName": "Dr. Jebediah Springfield",
  "isMessageable": true,
  "personnelAlias": "8340861319",
  "createdAt": "2022-02-01T10:00:00.000Z",
  "updatedAt": "2021-02-07T10:00:00.000Z"
}

POST /personnels

Creates a new personnel.

Parameters

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

Response Statuses

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

Updates a Personnel




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/consumer-engagement/v1/personnels/1a857d33-5b74-4c76-9a60-a008ea652cc6', headers: headers, body: {"domain":"demo.cernerdemo.healtheintent.com","millenniumPersonnelId":"42347421","displayName":"Dr. Jebediah Springfield"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/personnels/1a857d33-5b74-4c76-9a60-a008ea652cc6 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"domain":"demo.cernerdemo.healtheintent.com","millenniumPersonnelId":"42347421","displayName":"Dr. Jebediah Springfield"}

PUT /personnels/{id}

Updates a single personnel by ID.

Parameters

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

Response Statuses

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

Retrieves a Single Personnel


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/consumer-engagement/v1/personnels/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/consumer-engagement/v1/personnels/1a857d33-5b74-4c76-9a60-a008ea652cc6 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "40356955-6720-73ac-9224-8b713cc67a5d",
  "domain": "demo.cernerdemo.healtheintent.com",
  "millenniumPersonnelId": "823456234",
  "millenniumName": "Dr. Jebediah Springfield",
  "displayName": "Dr. Jebediah Springfield",
  "isMessageable": true,
  "personnelAlias": "8340861319",
  "createdAt": "2022-02-01T10:00:00.000Z",
  "updatedAt": "2021-02-07T10:00:00.000Z"
}

GET /personnels/{id}

Retrieves a single personnel by ID.

Parameters

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

Response Statuses

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

Creates/updates multiple personnel




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/consumer-engagement/v1/personnels/batch-upsert', headers: headers, body: {"domain":"portaleng.patientportal.us.healtheintent.com","personnel_file":"personnel_file.csv"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/personnels/batch-upsert \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"domain":"portaleng.patientportal.us.healtheintent.com","personnel_file":"personnel_file.csv"}

{
  "personnelFound": "50",
  "personnelCreated": "20",
  "personnelUpdated": "30",
  "errorDetails": [
    {
      "line": "50",
      "messages": [
        "Millennium name can't be blank"
      ]
    }
  ]
}

POST /personnels/batch-upsert

Creates/Updates personnel using data from a CSV file. Each line of the CSV file corresponds to one personnel. Personnel are created or updated as follows:

If a personnel with the specified millenniumPersonnelId and alias currently exists for the tenantId and domain, its displayName is updated to the values specified in the file

If a personnel with the specified millenniumPersonnelId and alias does not exist for the tenantId and domain, a new personnel is created using the details from the CSV file. IsMessageable and Cerner Millennium names are retrieved from Cerner Millennium

The CSV file must contain the following columns -

ML_PERSONNEL_ID

ALIAS

DISPLAY_NAME

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
200	OK	No Content	ConsumerEngagementPublicApi_Entities_V1_HealthelifeMessaging_BatchUpsertPersonnelResponse
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Retrieves a List of Sync Recipients


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/consumer-engagement/v1/sync-recipients', headers: headers)

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "40356955-6720-73ac-9224-8b713cc67a5d",
      "domain": "demo.cernerdemo.healtheintent.com",
      "recipientType": "POOL",
      "status": "NOT_STARTED",
      "statusDetail": "Pools successfully synced. Newly created pool records: 10, updated records: 5.",
      "createdAt": "2021-11-01T10:00:00.000Z",
      "updatedAt": "2021-11-07T10:00:00.000Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/sync-recipients?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/sync-recipients?offset=0&limit=20"
}

GET /sync-recipients

Retrieves a list of sync recipients.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
domain	query	string	false	N/A	The domain for which the recipients are to be synced.	-
recipientType	query	string	false	N/A	The type of recipients to be synced	-
status	query	string	false	N/A	The current status of the sync recipient request.	-
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	SyncRecipients
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error

Creates a Sync Recipient




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/consumer-engagement/v1/sync-recipients', headers: headers, body: {"domain":"demo.cernerdemo.healtheintent.com","recipientType":"POOL"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/sync-recipients \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"domain":"demo.cernerdemo.healtheintent.com","recipientType":"POOL"}

{
  "id": "40356955-6720-73ac-9224-8b713cc67a5d",
  "domain": "demo.cernerdemo.healtheintent.com",
  "recipientType": "POOL",
  "status": "NOT_STARTED",
  "statusDetail": "Pools successfully synced. Newly created pool records: 10, updated records: 5.",
  "createdAt": "2021-11-01T10:00:00.000Z",
  "updatedAt": "2021-11-07T10:00:00.000Z"
}

POST /sync-recipients

Creates a sync request for given recipient type to fetch the latest data from Cerner Millennium. The sync job is processed asynchronously and the status of the job is updated once it starts processing. For type PERSONNEL, all the existing PERSONNEL records are synced with Cerner Millennium to update their recipient access status. For type POOL, the new pools are synced from Cerner Millennium, and existing POOL records are updated to reflect the most recent recipient access status.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
201	Created	Created	ConsumerEngagementPublicApi_Entities_V1_HealthelifeMessaging_SyncRecipient
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error

Retrieves a Single Sync Recipient


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/consumer-engagement/v1/sync-recipients/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/consumer-engagement/v1/sync-recipients/1a857d33-5b74-4c76-9a60-a008ea652cc6 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "40356955-6720-73ac-9224-8b713cc67a5d",
  "domain": "demo.cernerdemo.healtheintent.com",
  "recipientType": "POOL",
  "status": "NOT_STARTED",
  "statusDetail": "Pools successfully synced. Newly created pool records: 10, updated records: 5.",
  "createdAt": "2021-11-01T10:00:00.000Z",
  "updatedAt": "2021-11-07T10:00:00.000Z"
}

GET /sync-recipients/{syncRecipientId}

Retrieves a single sync recipient by ID.

Parameters

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

Response Statuses

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

Retrieves a list of message recipients


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/consumer-engagement/v1/message-recipients',
  query: {
  'domain' => 'string',
'patientId' => 'array[string]',
'messageType' => 'string'
}, headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/message-recipients?domain=type,string&patientId=type,array,items,%5Bobject%20Object%5D&messageType=APPOINTMENT_SCHEDULE \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "patientId": "12560038",
      "recipients": [
        {
          "id": "13760354",
          "type": "PERSONNEL",
          "displayName": "Dr. Test Provider"
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/message-recipients?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/message-recipients?offset=0&limit=20"
}

GET /message-recipients

Retrieves a list of message recipients.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
domain	query	string	true	N/A	The domain from the given tenant.	-
patientId	query	array[string]	true	N/A	The Cerner Millennium identifier of a patient.	-
messageType	query	string	true	N/A	Message types are pre-defined keys to describe what type of message the consumer is sending to the recipient. Supported message types are GENERAL, APPOINTMENT_SCHEDULE, APPOINTMENT_RESCHEDULE, APPOINTMENT_CANCEL, MEDICATION_REFILL, PRESCRIPTION_RENEWAL, PATIENT_INFORMATION.	-
displayName	query	string	false	N/A	The display name of the recipient by which to filter the recipients list.	-
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	MessageRecipientLists
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error

Retrieves a List of Predefined Subjects


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/consumer-engagement/v1/pre-defined-subjects', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/pre-defined-subjects \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "40356955-6720-73ac-9224-8b713cc67a5d",
      "domain": "demo.cernerdemo.healtheintent.com",
      "subject": "Appointment Schedule",
      "locale": "en-US",
      "createdAt": "2021-11-01T10:00:00.000Z",
      "updatedAt": "2021-11-07T10:00:00.000Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/pre-defined-subjects?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/pre-defined-subjects?offset=0&limit=20"
}

GET /pre-defined-subjects

Retrieves a list of predefined subjects.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
domain	query	string	false	N/A	The domain with which the predefined subject is associated.	-
subject	query	string	false	N/A	The predefined subject string. The predefined subject option is available only when pre_defined_subject_enabled is set to True in messaging configurations for this domain.	-
locale	query	string	false	N/A	The locale with which the predefined subject is associated.	-
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	PreDefinedSubjects
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error

Creates a Predefined Subject




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/consumer-engagement/v1/pre-defined-subjects', headers: headers, body: {"domain":"demo.cernerdemo.healtheintent.com","subject":"Appointment Schedule","locale":"en-US"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/pre-defined-subjects \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"domain":"demo.cernerdemo.healtheintent.com","subject":"Appointment Schedule","locale":"en-US"}

{
  "id": "40356955-6720-73ac-9224-8b713cc67a5d",
  "domain": "demo.cernerdemo.healtheintent.com",
  "subject": "Appointment Schedule",
  "locale": "en-US",
  "createdAt": "2021-11-01T10:00:00.000Z",
  "updatedAt": "2021-11-07T10:00:00.000Z"
}

POST /pre-defined-subjects

Creates predefined subject using specified parameters.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
201	Created	Created	ConsumerEngagementPublicApi_Entities_V1_HealthelifeMessaging_PreDefinedSubject
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error

Deletes a Single Predefined Subject by ID


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/consumer-engagement/v1/pre-defined-subjects/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/consumer-engagement/v1/pre-defined-subjects/1a857d33-5b74-4c76-9a60-a008ea652cc6 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /pre-defined-subjects/{preDefinedSubjectId}

Deletes a single predefined subject by ID.

Parameters

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

Response Statuses

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

Updates a Single Predefined Subject




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/consumer-engagement/v1/pre-defined-subjects/1a857d33-5b74-4c76-9a60-a008ea652cc6', headers: headers, body: {"domain":"demo.cernerdemo.healtheintent.com","subject":"Appointment Schedule","locale":"en-US"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/pre-defined-subjects/1a857d33-5b74-4c76-9a60-a008ea652cc6 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"domain":"demo.cernerdemo.healtheintent.com","subject":"Appointment Schedule","locale":"en-US"}

PUT /pre-defined-subjects/{preDefinedSubjectId}

Updates a single predefined subject by ID.

Parameters

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

Response Statuses

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

Retrieves a Single Predefined Subject


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/consumer-engagement/v1/pre-defined-subjects/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/consumer-engagement/v1/pre-defined-subjects/1a857d33-5b74-4c76-9a60-a008ea652cc6 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "40356955-6720-73ac-9224-8b713cc67a5d",
  "domain": "demo.cernerdemo.healtheintent.com",
  "subject": "Appointment Schedule",
  "locale": "en-US",
  "createdAt": "2021-11-01T10:00:00.000Z",
  "updatedAt": "2021-11-07T10:00:00.000Z"
}

GET /pre-defined-subjects/{preDefinedSubjectId}

Retrieves a single predefined subject by ID.

Parameters

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

Response Statuses

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

Patient Clipboards

Allows clipboards to be assigned to patients, and patients to update the information and submit it for review.

Create or Update Responses for a Patient on a Custom 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/consumer-engagement/v1/patients/1234567/clipboards/e92ca89f-8524-451a-9346-666d6ff39329/sections/7d001e7a-14e2-4ed2-808a-b086714e4716/forms/c062a1e1-106b-4be1-9433-d704d4f66a48/question-responses', headers: headers, body: {"responses":[{"questionId":"850f5b16-1d50-4858-aec9-1626511f2440","answer":{"value":"3"}},{"questionId":"3be2725a-4fc4-4c04-a14b-0aefff2fe36b","answer":{"value":"2022-03-24"}},{"questionId":"6cef885c-8245-4917-bb78-fa6d5195a73e","answer":{"value":"Moderate pain level"}},{"questionId":"2eb30f49-f3cd-470d-ad53-12265c26ee71","answer":{"selectedChoices":[{"nomenclatureId":"5002"}]}},{"questionId":"686e1122-735d-4251-a31e-1ffeeb58aa4a","answer":{"selectedChoices":[{"nomenclatureId":"1234"},{"nomenclatureId":"3456"}]}},{"questionId":"93def023-15dd-409c-8cec-a3fc54d25461","answer":{"value":"Shoulder","selectedChoices":[{"nomenclatureId":"6001"},{"nomenclatureId":"6003"}]}}],"createdById":"JSMITH"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/patients/1234567/clipboards/e92ca89f-8524-451a-9346-666d6ff39329/sections/7d001e7a-14e2-4ed2-808a-b086714e4716/forms/c062a1e1-106b-4be1-9433-d704d4f66a48/question-responses \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"responses":[{"questionId":"850f5b16-1d50-4858-aec9-1626511f2440","answer":{"value":"3"}},{"questionId":"3be2725a-4fc4-4c04-a14b-0aefff2fe36b","answer":{"value":"2022-03-24"}},{"questionId":"6cef885c-8245-4917-bb78-fa6d5195a73e","answer":{"value":"Moderate pain level"}},{"questionId":"2eb30f49-f3cd-470d-ad53-12265c26ee71","answer":{"selectedChoices":[{"nomenclatureId":"5002"}]}},{"questionId":"686e1122-735d-4251-a31e-1ffeeb58aa4a","answer":{"selectedChoices":[{"nomenclatureId":"1234"},{"nomenclatureId":"3456"}]}},{"questionId":"93def023-15dd-409c-8cec-a3fc54d25461","answer":{"value":"Shoulder","selectedChoices":[{"nomenclatureId":"6001"},{"nomenclatureId":"6003"}]}}],"createdById":"JSMITH"}

POST /patients/{patientId}/clipboards/{clipboardId}/sections/{sectionId}/forms/{formId}/question-responses

Creates or updates responses for a patient on a custom form.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
patientId	path	string	true	N/A	The unique ID of the patient assigned to the clipboard.	-
clipboardId	path	string	true	N/A	The unique ID of the clipboard assigned to a patient.	-
sectionId	path	string	true	N/A	The unique ID of the section associated with a clipboard.	-
formId	path	string	true	N/A	The unique ID of the form associated with a clipboard section.	-
body	body	postPatientsPatientidClipboardsClipboardidSectionsSectionidFormsFormidQuestionResponses	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

Update a Clipboard Status for a Patient




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/consumer-engagement/v1/patients/{patientId}/clipboards/f4fe43cb-437a-4488-b75e-ef680a665561', headers: headers, body: {"status":"IN_PROGRESS","updatedById":"JSMITH","updatedByProxy":true}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/patients/{patientId}/clipboards/f4fe43cb-437a-4488-b75e-ef680a665561 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"status":"IN_PROGRESS","updatedById":"JSMITH","updatedByProxy":true}

{
  "id": "8ee87e4f-743d-4d9e-aec4-99ceec9e6e94",
  "status": "IN_PROGRESS",
  "nameFriendly": "Health Information",
  "policyText": "Health Information policy text",
  "requestRemovalPolicyText": "Health Information removal policy",
  "successMessagePolicyText": "Health Information success message",
  "event": {
    "id": "a2bfc3bd-ae92-4f62-bf6c-6444cdea841c",
    "type": "ENCOUNTER",
    "locationId": "9ab841aa-b2d1-4ffa-95ae-c7b43ba78e0e",
    "appointment": {
      "id": "5fc24ee1-932b-4e1c-90c9-3e6c1257fcc3",
      "appointmentAt": "2022-04-15T15:30:00.000Z",
      "appointmentTypeId": "d9df9d82-3a18-4b39-9ef1-1b7ac719e145",
      "provider": "Dr. Smith"
    },
    "encounter": {
      "id": "4b523fb7-07e1-453f-9d3c-ae503e509448",
      "personnelId": "51b38cef-db04-4144-8820-c3e433121b19",
      "poolId": "a4709564-7b94-4f28-9ef0-444fd302e36f"
    }
  },
  "sections": [
    {
      "id": "8ee87e4f-743d-4d9e-aec4-99ceec9e6e94",
      "name": "Health History",
      "description": "This section is for your health information.",
      "millenniumDocumentCode": "DOCUMENT_ID_1",
      "position": 1,
      "createdAt": "2020-01-20T05:40:02.000Z",
      "updatedAt": "2020-01-20T05:40:02.000Z",
      "patientFinished": true,
      "forms": [
        {
          "id": "8ee87e4f-743d-4d9e-aec4-99ceec9e6e94",
          "nameFriendly": "Allergies",
          "position": 1,
          "isSensitive": true,
          "type": "STANDARD",
          "formConfigId": "0ba27b81-525b-4578-a877-c7f6b1f890f7",
          "codifiedLists": [
            {
              "id": "8ee87e4f-743d-4d9e-aec4-99ceec9e6e94",
              "name": "Allergies",
              "type": "ALLERGIES"
            }
          ],
          "createdAt": "2020-01-20T05:40:02.000Z",
          "updatedAt": "2020-01-30T05:30:02.000Z",
          "updatedByProxy": true,
          "patientFinished": true
        }
      ]
    }
  ]
}

PUT /patients/{patientId}/clipboards/{clipboardId}

Updates the status of a clipboard that is assigned to a patient.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
patientId	path	string	true	N/A	The unique ID of the patient assigned to the clipboard.	-
clipboardId	path	string	true	N/A	The unique ID of the clipboard assigned to a patient.	-
body	body	putPatientsPatientidClipboards	true	N/A	No description	-

Response Statuses

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

Retrieve a Single Clipboard for a Patient


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/consumer-engagement/v1/patients/{patientId}/clipboards/{clipboardId}', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/patients/{patientId}/clipboards/{clipboardId} \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "8ee87e4f-743d-4d9e-aec4-99ceec9e6e94",
  "status": "IN_PROGRESS",
  "nameFriendly": "Health Information",
  "policyText": "Health Information policy text",
  "requestRemovalPolicyText": "Health Information removal policy",
  "successMessagePolicyText": "Health Information success message",
  "event": {
    "id": "a2bfc3bd-ae92-4f62-bf6c-6444cdea841c",
    "type": "ENCOUNTER",
    "locationId": "9ab841aa-b2d1-4ffa-95ae-c7b43ba78e0e",
    "appointment": {
      "id": "5fc24ee1-932b-4e1c-90c9-3e6c1257fcc3",
      "appointmentAt": "2022-04-15T15:30:00.000Z",
      "appointmentTypeId": "d9df9d82-3a18-4b39-9ef1-1b7ac719e145",
      "provider": "Dr. Smith"
    },
    "encounter": {
      "id": "4b523fb7-07e1-453f-9d3c-ae503e509448",
      "personnelId": "51b38cef-db04-4144-8820-c3e433121b19",
      "poolId": "a4709564-7b94-4f28-9ef0-444fd302e36f"
    }
  },
  "sections": [
    {
      "id": "8ee87e4f-743d-4d9e-aec4-99ceec9e6e94",
      "name": "Health History",
      "description": "This section is for your health information.",
      "millenniumDocumentCode": "DOCUMENT_ID_1",
      "position": 1,
      "createdAt": "2020-01-20T05:40:02.000Z",
      "updatedAt": "2020-01-20T05:40:02.000Z",
      "patientFinished": true,
      "forms": [
        {
          "id": "8ee87e4f-743d-4d9e-aec4-99ceec9e6e94",
          "nameFriendly": "Allergies",
          "position": 1,
          "isSensitive": true,
          "type": "STANDARD",
          "formConfigId": "0ba27b81-525b-4578-a877-c7f6b1f890f7",
          "codifiedLists": [
            {
              "id": "8ee87e4f-743d-4d9e-aec4-99ceec9e6e94",
              "name": "Allergies",
              "type": "ALLERGIES"
            }
          ],
          "createdAt": "2020-01-20T05:40:02.000Z",
          "updatedAt": "2020-01-30T05:30:02.000Z",
          "updatedByProxy": true,
          "patientFinished": true
        }
      ]
    }
  ]
}

GET /patients/{patientId}/clipboards/{clipboardId}

Retrieves a single clipboard that has been assigned to a patient.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
patientId	path	string	true	N/A	The unique ID of the patient assigned to the clipboard.	-
clipboardId	path	string	true	N/A	The unique ID of the clipboard assigned to a patient.	-

Response Statuses

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

Retrieve a List of Clipboards for a Patient


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

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json',
  'Accept-Language' => 'en-US'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/patients/{patientId}/clipboards', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/patients/{patientId}/clipboards \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json' \
-H 'Accept-Language: en-US'

{
  "items": [
    {
      "id": "8ee87e4f-743d-4d9e-aec4-99ceec9e6e94",
      "clipboardLink": "https://app.patientportal.us.healtheintent.com/clipboards/8ee87e4f-743d-4d9e-aec4-99ceec9e6e94",
      "status": "IN_PROGRESS",
      "nameFriendly": "Health Information",
      "createdAt": "2020-01-20T05:40:02.000Z",
      "startedAt": "2020-01-27T05:40:02.000Z",
      "updatedAt": "2020-01-30T05:30:02.000Z",
      "event": {
        "id": "a2bfc3bd-ae92-4f62-bf6c-6444cdea841c",
        "type": "ENCOUNTER",
        "locationId": "9ab841aa-b2d1-4ffa-95ae-c7b43ba78e0e",
        "appointment": {
          "id": "5fc24ee1-932b-4e1c-90c9-3e6c1257fcc3",
          "appointmentAt": "2022-04-15T15:30:00.000Z",
          "appointmentTypeId": "d9df9d82-3a18-4b39-9ef1-1b7ac719e145",
          "provider": "Dr. Smith"
        },
        "encounter": {
          "id": "4b523fb7-07e1-453f-9d3c-ae503e509448",
          "personnelId": "51b38cef-db04-4144-8820-c3e433121b19",
          "poolId": "a4709564-7b94-4f28-9ef0-444fd302e36f"
        }
      },
      "clipboardId": "c85236cb-8d54-4d45-a677-ce252cc1869b"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/patients/1234567/clipboards?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/patients/1234567/clipboards?offset=0&limit=20"
}

GET /patients/{patientId}/clipboards

Retrieves the clipboards assigned to a patient that meet the specified parameters.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
Accept-Language	header	string	false	N/A	Filters by the locale the clipboard belongs to.	-
patientId	path	string	true	N/A	The unique ID of the patient assigned to the clipboard.	-
domain	query	string	false	N/A	Filters by the domain the clipboard belongs to.	-
eventType	query	string	false	N/A	Filters by the event type. The following values are supported: `ENCOUNTER`, `APPOINTMENT`, `OPTIONAL`.	ENCOUNTER, APPOINTMENT, OPTIONAL
status	query	string	false	N/A	Filters by the clipboard status. The following values are supported: `NOT_STARTED`, `IN_PROGRESS`, `IN_REVIEW`, `COMPLETED`, `ABORTED`, `INVALID`.	NOT_STARTED, IN_PROGRESS, IN_REVIEW, COMPLETED, ABORTED, INVALID
active	query	boolean	false	N/A	Filters by active or inactive clipboards.	-
clipboardIds	query	array[string]	false	N/A	Filters patient clipboards by clipboard IDs.	-
offset	query	integer(int32)	false	0	The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset.	-
limit	query	integer(int32)	false	20	The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100.	-
orderBy	query	string	false	N/A	A comma-separated list of fields by which to sort.	-updatedAt, -createdAt, -appointmentAt, updatedAt, createdAt, appointmentAt

Response Statuses

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

Create a New Clipboard Event




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/consumer-engagement/v1/patients/{patientId}/clipboard-events', headers: headers, body: {"eventType":"ENCOUNTER","locationId":"9ab841aa-b2d1-4ffa-95ae-c7b43ba78e0e","appointmentEvent":{"id":"5fc24ee1-932b-4e1c-90c9-3e6c1257fcc3","appointmentAt":"2022-04-15T15:30:00.000Z","appointmentTypeId":"d9df9d82-3a18-4b39-9ef1-1b7ac719e145","provider":"Dr. Smith"},"encounterEvent":{"id":"4b523fb7-07e1-453f-9d3c-ae503e509448","personnelId":"51b38cef-db04-4144-8820-c3e433121b19","poolId":"a4709564-7b94-4f28-9ef0-444fd302e36f","clipboards":[{"id":"8ee87e4f-743d-4d9e-aec4-99ceec9e6e94"}]},"createdById":"JSMITH"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/patients/{patientId}/clipboard-events \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"eventType":"ENCOUNTER","locationId":"9ab841aa-b2d1-4ffa-95ae-c7b43ba78e0e","appointmentEvent":{"id":"5fc24ee1-932b-4e1c-90c9-3e6c1257fcc3","appointmentAt":"2022-04-15T15:30:00.000Z","appointmentTypeId":"d9df9d82-3a18-4b39-9ef1-1b7ac719e145","provider":"Dr. Smith"},"encounterEvent":{"id":"4b523fb7-07e1-453f-9d3c-ae503e509448","personnelId":"51b38cef-db04-4144-8820-c3e433121b19","poolId":"a4709564-7b94-4f28-9ef0-444fd302e36f","clipboards":[{"id":"8ee87e4f-743d-4d9e-aec4-99ceec9e6e94"}]},"createdById":"JSMITH"}

{
  "event": {
    "id": "a2bfc3bd-ae92-4f62-bf6c-6444cdea841c",
    "type": "ENCOUNTER",
    "locationId": "9ab841aa-b2d1-4ffa-95ae-c7b43ba78e0e",
    "appointment": {
      "id": "5fc24ee1-932b-4e1c-90c9-3e6c1257fcc3",
      "appointmentAt": "2022-04-15T15:30:00.000Z",
      "appointmentTypeId": "d9df9d82-3a18-4b39-9ef1-1b7ac719e145",
      "provider": "Dr. Smith"
    },
    "encounter": {
      "id": "4b523fb7-07e1-453f-9d3c-ae503e509448",
      "personnelId": "51b38cef-db04-4144-8820-c3e433121b19",
      "poolId": "a4709564-7b94-4f28-9ef0-444fd302e36f"
    }
  },
  "clipboardsBaseUrl": "https://app.patientportal.us.devhealtheintent.com/clipboards",
  "clipboards": [
    {
      "id": "8ee87e4f-743d-4d9e-aec4-99ceec9e6e94",
      "link": "https://app.patientportal.us.healtheintent.com/clipboards/8ee87e4f-743d-4d9e-aec4-99ceec9e6e94",
      "status": "IN_PROGRESS"
    }
  ]
}

POST /patients/{patientId}/clipboard-events

Creates a clipboard event for an appointment or encounter.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
patientId	path	string	true	N/A	The unique ID of the patient assigned to the clipboard.	-
body	body	postPatientsPatientidClipboardEvents	true	N/A	No description	-

Response Statuses

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

Submit a Clipboard to Cerner Millennium




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/consumer-engagement/v1/patients/{patientId}/clipboards/{clipboardId}/submission', headers: headers, body: {"fullName":"Test Patient","isProxy":true}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/patients/{patientId}/clipboards/{clipboardId}/submission \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"fullName":"Test Patient","isProxy":true}

POST /patients/{patientId}/clipboards/{clipboardId}/submission

Submits the clipboard to Cerner Millennium once it has been completed.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
patientId	path	string	true	N/A	The unique ID of the patient assigned to the clipboard.	-
clipboardId	path	string	true	N/A	The unique ID of the clipboard assigned to a patient.	-
body	body	postPatientsPatientidClipboardsClipboardidSubmission	true	N/A	No description	-

Response Statuses

Status	Meaning	Description	Schema
204	No Content	Submitted.	None
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Update a Single Form as Finished




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/consumer-engagement/v1/patients/1234567/clipboards/e92ca89f-8524-451a-9346-666d6ff39329/sections/7d001e7a-14e2-4ed2-808a-b086714e4716/forms/c062a1e1-106b-4be1-9433-d704d4f66a48', headers: headers, body: {"patientFinished":true,"updatedById":"USER_1","updatedByProxy":true}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/patients/1234567/clipboards/e92ca89f-8524-451a-9346-666d6ff39329/sections/7d001e7a-14e2-4ed2-808a-b086714e4716/forms/c062a1e1-106b-4be1-9433-d704d4f66a48 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"patientFinished":true,"updatedById":"USER_1","updatedByProxy":true}

PUT /patients/{patientId}/clipboards/{clipboardId}/sections/{sectionId}/forms/{formId}

Updates a single form for a patient as finished.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
patientId	path	string	true	N/A	The unique ID of the patient assigned to the clipboard.	-
clipboardId	path	string	true	N/A	The unique ID of the clipboard assigned to a patient.	-
sectionId	path	string	true	N/A	The unique ID of the section associated with a clipboard.	-
formId	path	string	true	N/A	The unique ID of the form associated with a clipboard section.	-
body	body	putPatientsPatientidClipboardsClipboardidSectionsSectionidForms	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 Form for a Patient


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/consumer-engagement/v1/patients/1234567/clipboards/e92ca89f-8524-451a-9346-666d6ff39329/sections/7d001e7a-14e2-4ed2-808a-b086714e4716/forms/c062a1e1-106b-4be1-9433-d704d4f66a48', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/patients/1234567/clipboards/e92ca89f-8524-451a-9346-666d6ff39329/sections/7d001e7a-14e2-4ed2-808a-b086714e4716/forms/c062a1e1-106b-4be1-9433-d704d4f66a48 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "8ee87e4f-743d-4d9e-aec4-99ceec9e6e94",
  "nameFriendly": "Allergies",
  "policyText": "Allergies policy text",
  "allowFreeText": true,
  "isSensitive": true,
  "standardFormType": "ALLERGIES",
  "type": "STANDARD",
  "formConfigId": "0ba27b81-525b-4578-a877-c7f6b1f890f7",
  "codifiedLists": [
    {
      "id": "8ee87e4f-743d-4d9e-aec4-99ceec9e6e94",
      "name": "Allergies",
      "type": "ALLERGIES"
    }
  ],
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-30T05:30:02.000Z",
  "updatedById": "USER_1",
  "updatedByProxy": true,
  "patientFinished": true,
  "allergies": [
    {
      "id": "2a090f43-b746-481f-8ca2-259ea30f08df",
      "name": "Peanuts",
      "comments": "Sample comment.",
      "createdAt": "2020-01-20T05:40:02.000Z",
      "updatedAt": "2020-01-20T05:40:02.000Z",
      "source": "EMR",
      "status": "UPDATE",
      "nomenclatureId": "102691369",
      "reactions": [
        {
          "id": "8ee87e4f-743d-4d9e-aec4-99ceec9e6e94",
          "name": "Skin rash",
          "nomenclatureId": "6ff755b3-0696-4df5-8b2a-a0b118d6e347",
          "createdAt": "2020-01-20T05:40:02.000Z",
          "updatedAt": "2020-01-20T05:40:02.000Z"
        }
      ]
    }
  ],
  "procedures": [
    {
      "id": "2a090f43-b746-481f-8ca2-259ea30f08df",
      "name": "Tonsillectomy",
      "comments": "Removed to treat sleep apnea.",
      "createdAt": "2020-01-20T05:40:02.000Z",
      "updatedAt": "2020-01-20T05:40:02.000Z",
      "source": "EMR",
      "status": "UPDATE",
      "approximateDate": "2021-05-29",
      "nomenclatureId": "102691369"
    }
  ],
  "medications": [
    {
      "id": "2a090f43-b746-481f-8ca2-259ea30f08df",
      "name": "Medication test name",
      "comments": "Sample medication comment",
      "createdAt": "2020-01-20T05:40:02.000Z",
      "updatedAt": "2020-01-20T05:40:02.000Z",
      "source": "EMR",
      "status": "UPDATE",
      "synonymId": "102691369",
      "dose": "1 tablet",
      "frequency": "Once daily at bedtime.",
      "prescribingProvider": "Provider MD, Test",
      "userStatus": "AS_PRESCRIBED",
      "userStatusLabel": "Taking as shown."
    }
  ],
  "immunizations": [
    {
      "id": "2a090f43-b746-481f-8ca2-259ea30f08df",
      "name": "Immunization test name",
      "comments": "Sample immunization comment",
      "createdAt": "2020-01-20T05:40:02.000Z",
      "updatedAt": "2020-01-20T05:40:02.000Z",
      "source": "EMR",
      "status": "KEEP",
      "eventCode": "102691369",
      "approximateDate": "2022-02-24"
    }
  ],
  "questionnaire": [
    {
      "id": "41bb329f-e549-46f5-8f9f-a96853a20361",
      "type": "TEXTBOX",
      "fields": {
        "text": "Please answer the following questions about your visit."
      },
      "position": 1
    },
    {
      "id": "850f5b16-1d50-4858-aec9-1626511f2440",
      "type": "QUESTION",
      "fields": {
        "label": "How many days have you exercised?",
        "isRequired": true,
        "dta": {
          "id": "1000",
          "type": "NUMERIC",
          "eventCode": "1005",
          "referenceRange": {
            "feasibleLow": 0,
            "feasibleHigh": 30,
            "unit": {
              "value": 125,
              "display": "days",
              "meaning": "DAYS"
            }
          },
          "dataMap": {
            "minDigits": 1,
            "maxDigits": 2,
            "maxDecimals": 0
          }
        }
      },
      "position": 2
    },
    {
      "id": "3be2725a-4fc4-4c04-a14b-0aefff2fe36b",
      "type": "QUESTION",
      "fields": {
        "label": "When is the last date that you exercised?",
        "isRequired": true,
        "dta": {
          "id": "2000",
          "type": "DATE",
          "eventCode": "2005"
        }
      },
      "position": 3
    },
    {
      "id": "6cef885c-8245-4917-bb78-fa6d5195a73e",
      "type": "QUESTION",
      "fields": {
        "label": "What level of pain do you have?",
        "isRequired": true,
        "dta": {
          "id": "3000",
          "type": "TEXT",
          "eventCode": "3005"
        }
      },
      "position": 4
    },
    {
      "id": "2eb30f49-f3cd-470d-ad53-12265c26ee71",
      "type": "QUESTION",
      "fields": {
        "label": "Select the number of days you exercised this week.",
        "isRequired": true,
        "dta": {
          "id": "4000",
          "type": "ALPHA",
          "eventCode": "4005",
          "referenceRange": {
            "feasibleLow": 0,
            "feasibleHigh": 30,
            "unit": {
              "value": 125,
              "display": "days",
              "meaning": "DAYS"
            }
          },
          "dataMap": {
            "minDigits": 2,
            "maxDigits": 4,
            "maxDecimals": 1.2
          },
          "choices": [
            {
              "nomenclatureId": "5001",
              "description": "0 days",
              "sequence": "1",
              "isDefault": true,
              "isActive": true,
              "resultValue": "1.0"
            },
            {
              "nomenclatureId": "5002",
              "description": "2 days or less",
              "sequence": "2",
              "isDefault": false,
              "isActive": true,
              "resultValue": "2.0"
            },
            {
              "nomenclatureId": "5003",
              "description": "3 to 5 days",
              "sequence": "3",
              "isDefault": false,
              "isActive": true,
              "resultValue": "3.0"
            },
            {
              "nomenclatureId": "5004",
              "description": "6 to 7 days",
              "sequence": "4",
              "isDefault": false,
              "isActive": true,
              "resultValue": "4.0"
            }
          ]
        }
      },
      "position": 5
    },
    {
      "id": "686e1122-735d-4251-a31e-1ffeeb58aa4a",
      "type": "QUESTION",
      "fields": {
        "label": "Select the meals you have eaten today.",
        "isRequired": true,
        "dta": {
          "id": "5000",
          "type": "MULTI",
          "eventCode": "5005",
          "choices": [
            {
              "nomenclatureId": "1234",
              "description": "Breakfast",
              "sequence": "1",
              "isDefault": false,
              "isActive": true,
              "resultValue": "1.0"
            },
            {
              "nomenclatureId": "2345",
              "description": "Lunch",
              "sequence": "2",
              "isDefault": false,
              "isActive": true,
              "resultValue": "2.0"
            },
            {
              "nomenclatureId": "3456",
              "description": "Dinner",
              "sequence": "3",
              "isDefault": false,
              "isActive": true,
              "resultValue": "3.0"
            }
          ]
        }
      },
      "position": 6
    },
    {
      "id": "93def023-15dd-409c-8cec-a3fc54d25461",
      "type": "QUESTION",
      "fields": {
        "label": "Where is your pain located?",
        "isRequired": true,
        "dta": {
          "id": "6000",
          "type": "MULTI_ALPHA_AND_FREE_TEXT",
          "eventCode": "6005",
          "choices": [
            {
              "nomenclatureId": "6001",
              "description": "Lower back",
              "sequence": "1",
              "isDefault": false,
              "isActive": true,
              "resultValue": "1.0"
            },
            {
              "nomenclatureId": "6002",
              "description": "Upper back",
              "sequence": "2",
              "isDefault": false,
              "isActive": true,
              "resultValue": "2.0"
            },
            {
              "nomenclatureId": "6003",
              "description": "Left arm",
              "sequence": "3",
              "isDefault": false,
              "isActive": true,
              "resultValue": "3.0"
            }
          ]
        }
      },
      "position": 7
    },
    {
      "id": "c0bbccf6-2f58-4001-ac08-73fb7af2bf13",
      "type": "QUESTION",
      "fields": {
        "label": "Wellness Score",
        "isPatientViewableScore": true,
        "dta": {
          "id": "7000",
          "type": "CALCULATION",
          "eventCode": "7005"
        }
      },
      "position": 8
    }
  ],
  "questionnaireResponse": {
    "responses": [
      {
        "questionId": "850f5b16-1d50-4858-aec9-1626511f2440",
        "answer": {
          "value": "3"
        },
        "createdById": "JSMITH",
        "createdAt": "2020-01-30T05:30:02.000Z",
        "updatedById": "JSMITH",
        "updatedAt": "2020-01-30T05:30:02.000Z"
      },
      {
        "questionId": "3be2725a-4fc4-4c04-a14b-0aefff2fe36b",
        "answer": {
          "value": "2022-03-24"
        },
        "createdById": "JSMITH",
        "createdAt": "2020-01-30T05:30:02.000Z",
        "updatedById": "JSMITH",
        "updatedAt": "2020-01-30T05:30:02.000Z"
      },
      {
        "questionId": "6cef885c-8245-4917-bb78-fa6d5195a73e",
        "answer": {
          "value": "Moderate pain level"
        },
        "createdById": "JSMITH",
        "createdAt": "2020-01-30T05:30:02.000Z",
        "updatedById": "JSMITH",
        "updatedAt": "2020-01-30T05:30:02.000Z"
      },
      {
        "questionId": "2eb30f49-f3cd-470d-ad53-12265c26ee71",
        "answer": {
          "selectedChoices": [
            {
              "nomenclatureId": "5002"
            }
          ]
        },
        "createdById": "JSMITH",
        "createdAt": "2020-01-30T05:30:02.000Z",
        "updatedById": "JSMITH",
        "updatedAt": "2020-01-30T05:30:02.000Z"
      },
      {
        "questionId": "686e1122-735d-4251-a31e-1ffeeb58aa4a",
        "answer": {
          "selectedChoices": [
            {
              "nomenclatureId": "1234"
            },
            {
              "nomenclatureId": "3456"
            }
          ]
        },
        "createdById": "JSMITH",
        "createdAt": "2020-01-30T05:30:02.000Z",
        "updatedById": "JSMITH",
        "updatedAt": "2020-01-30T05:30:02.000Z"
      },
      {
        "questionId": "93def023-15dd-409c-8cec-a3fc54d25461",
        "answer": {
          "value": "Shoulder",
          "selectedChoices": [
            {
              "nomenclatureId": "6001"
            },
            {
              "nomenclatureId": "6003"
            }
          ]
        },
        "createdById": "JSMITH",
        "createdAt": "2020-01-30T05:30:02.000Z",
        "updatedById": "JSMITH",
        "updatedAt": "2020-01-30T05:30:02.000Z"
      },
      {
        "questionId": "c0bbccf6-2f58-4001-ac08-73fb7af2bf13",
        "answer": {
          "value": "26"
        },
        "createdById": "JSMITH",
        "createdAt": "2020-01-30T05:30:02.000Z",
        "updatedById": "JSMITH",
        "updatedAt": "2020-01-30T05:30:02.000Z"
      }
    ]
  }
}

GET /patients/{patientId}/clipboards/{clipboardId}/sections/{sectionId}/forms/{formId}

Retrieves the details of a single form for a patient.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
patientId	path	string	true	N/A	The unique ID of the patient assigned to the clipboard.	-
clipboardId	path	string	true	N/A	The unique ID of the clipboard assigned to a patient.	-
sectionId	path	string	true	N/A	The unique ID of the section associated with a clipboard.	-
formId	path	string	true	N/A	The unique ID of the form associated with a clipboard section.	-

Response Statuses

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

Delete a Patient-Entered Item on a Clipboard 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/consumer-engagement/v1/patients/{patientId}/clipboards/{clipboardId}/sections/{sectionId}/forms/{formId}/items/{itemId}', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/patients/{patientId}/clipboards/{clipboardId}/sections/{sectionId}/forms/{formId}/items/{itemId} \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /patients/{patientId}/clipboards/{clipboardId}/sections/{sectionId}/forms/{formId}/items/{itemId}

Deletes a patient-entered item (not imported from the EMR) from a clipboard form for the patient.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
patientId	path	string	true	N/A	The unique ID of the patient assigned to the clipboard.	-
clipboardId	path	string	true	N/A	The unique ID of the clipboard assigned to a patient.	-
sectionId	path	string	true	N/A	The unique ID of the section associated with a clipboard.	-
formId	path	string	true	N/A	The unique ID of the form associated with a clipboard section.	-
itemId	path	string	true	N/A	The unique ID of an item associated with a form.	-

Response Statuses

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

Update an Item on a Clipboard 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/consumer-engagement/v1/patients/{patientId}/clipboards/{clipboardId}/sections/{sectionId}/forms/{formId}/items/{itemId}', headers: headers, body: {"allergy":{"comments":"Sample comment.","source":"EMR","status":"UPDATE","reactions":[{"id":"8ee87e4f-743d-4d9e-aec4-99ceec9e6e94","name":"Skin rash","nomenclatureId":"6ff755b3-0696-4df5-8b2a-a0b118d6e347"}]},"procedure":{"comments":"Removed to treat sleep apnea.","source":"EMR","status":"UPDATE","approximateDate":"2021-05-29"},"medication":{"comments":"Sample medication comment","source":"EMR","status":"UPDATE","dose":"1 tablet","frequency":"Once daily at bedtime.","prescribingProvider":"Provider MD, Test","userStatus":"AS_PRESCRIBED","userStatusLabel":"Taking as shown."},"immunization":{"comments":"Sample immunization comment","source":"PATIENT","status":"ADD","approximateDate":"2022-02-24"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/patients/{patientId}/clipboards/{clipboardId}/sections/{sectionId}/forms/{formId}/items/{itemId} \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"allergy":{"comments":"Sample comment.","source":"EMR","status":"UPDATE","reactions":[{"id":"8ee87e4f-743d-4d9e-aec4-99ceec9e6e94","name":"Skin rash","nomenclatureId":"6ff755b3-0696-4df5-8b2a-a0b118d6e347"}]},"procedure":{"comments":"Removed to treat sleep apnea.","source":"EMR","status":"UPDATE","approximateDate":"2021-05-29"},"medication":{"comments":"Sample medication comment","source":"EMR","status":"UPDATE","dose":"1 tablet","frequency":"Once daily at bedtime.","prescribingProvider":"Provider MD, Test","userStatus":"AS_PRESCRIBED","userStatusLabel":"Taking as shown."},"immunization":{"comments":"Sample immunization comment","source":"PATIENT","status":"ADD","approximateDate":"2022-02-24"}}

{
  "allergy": {
    "id": "2a090f43-b746-481f-8ca2-259ea30f08df",
    "name": "Peanuts",
    "comments": "Sample comment.",
    "createdAt": "2020-01-20T05:40:02.000Z",
    "updatedAt": "2020-01-20T05:40:02.000Z",
    "source": "EMR",
    "status": "UPDATE",
    "nomenclatureId": "102691369",
    "reactions": [
      {
        "id": "8ee87e4f-743d-4d9e-aec4-99ceec9e6e94",
        "name": "Skin rash",
        "nomenclatureId": "6ff755b3-0696-4df5-8b2a-a0b118d6e347",
        "createdAt": "2020-01-20T05:40:02.000Z",
        "updatedAt": "2020-01-20T05:40:02.000Z"
      }
    ]
  },
  "medication": {
    "id": "2a090f43-b746-481f-8ca2-259ea30f08df",
    "name": "Medication test name",
    "comments": "Sample medication comment",
    "createdAt": "2020-01-20T05:40:02.000Z",
    "updatedAt": "2020-01-20T05:40:02.000Z",
    "source": "EMR",
    "status": "UPDATE",
    "synonymId": "102691369",
    "dose": "1 tablet",
    "frequency": "Once daily at bedtime.",
    "prescribingProvider": "Provider MD, Test",
    "userStatus": "AS_PRESCRIBED",
    "userStatusLabel": "Taking as shown."
  },
  "immunization": {
    "id": "2a090f43-b746-481f-8ca2-259ea30f08df",
    "name": "Immunization test name",
    "comments": "Sample immunization comment",
    "createdAt": "2020-01-20T05:40:02.000Z",
    "updatedAt": "2020-01-20T05:40:02.000Z",
    "source": "PATIENT",
    "status": "ADD",
    "eventCode": "102691369",
    "approximateDate": "2022-02-24"
  },
  "procedure": {
    "id": "2a090f43-b746-481f-8ca2-259ea30f08df",
    "name": "Tonsillectomy",
    "comments": "Removed to treat sleep apnea.",
    "createdAt": "2020-01-20T05:40:02.000Z",
    "updatedAt": "2020-01-20T05:40:02.000Z",
    "source": "EMR",
    "status": "UPDATE",
    "approximateDate": "2021-05-29",
    "nomenclatureId": "102691369"
  }
}

PUT /patients/{patientId}/clipboards/{clipboardId}/sections/{sectionId}/forms/{formId}/items/{itemId}

Updates an item on a clipboard form for the patient.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
patientId	path	string	true	N/A	The unique ID of the patient assigned to the clipboard.	-
clipboardId	path	string	true	N/A	The unique ID of the clipboard assigned to a patient.	-
sectionId	path	string	true	N/A	The unique ID of the section associated with a clipboard.	-
formId	path	string	true	N/A	The unique ID of the form associated with a clipboard section.	-
itemId	path	string	true	N/A	The unique ID of an item associated with a form.	-
body	body	putPatientsPatientidClipboardsClipboardidSectionsSectionidFormsFormidItems	true	N/A	No description	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	Updated.	ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_FormItems_FullUpdateItemEntity
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Create a Patient-Entered Item on a Clipboard 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/consumer-engagement/v1/patients/{patientId}/clipboards/{clipboardId}/sections/{sectionId}/forms/{formId}/items', headers: headers, body: {"allergy":{"name":"Peanuts","comments":"Sample comment.","nomenclatureId":"102691369","reactions":[{"name":"Skin rash","nomenclatureId":"6ff755b3-0696-4df5-8b2a-a0b118d6e347"}]},"procedure":{"name":"Tonsillectomy","comments":"Removed to treat sleep apnea.","approximateDate":"2021-05-29","nomenclatureId":"102691369"},"medication":{"name":"Medication test name","comments":"Sample medication comment","synonymId":"102691369","dose":"1 tablet","frequency":"Once daily at bedtime.","prescribingProvider":"Provider MD, Test","userStatus":"AS_PRESCRIBED","userStatusLabel":"Taking as shown."},"immunization":{"name":"Immunization test name","comments":"Sample immunization comment","eventCode":"102691369","approximateDate":"2022-02-24"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-engagement/v1/patients/{patientId}/clipboards/{clipboardId}/sections/{sectionId}/forms/{formId}/items \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"allergy":{"name":"Peanuts","comments":"Sample comment.","nomenclatureId":"102691369","reactions":[{"name":"Skin rash","nomenclatureId":"6ff755b3-0696-4df5-8b2a-a0b118d6e347"}]},"procedure":{"name":"Tonsillectomy","comments":"Removed to treat sleep apnea.","approximateDate":"2021-05-29","nomenclatureId":"102691369"},"medication":{"name":"Medication test name","comments":"Sample medication comment","synonymId":"102691369","dose":"1 tablet","frequency":"Once daily at bedtime.","prescribingProvider":"Provider MD, Test","userStatus":"AS_PRESCRIBED","userStatusLabel":"Taking as shown."},"immunization":{"name":"Immunization test name","comments":"Sample immunization comment","eventCode":"102691369","approximateDate":"2022-02-24"}}

{
  "allergy": {
    "id": "2a090f43-b746-481f-8ca2-259ea30f08df",
    "name": "Peanuts",
    "comments": "Sample comment.",
    "createdAt": "2020-01-20T05:40:02.000Z",
    "updatedAt": "2020-01-20T05:40:02.000Z",
    "source": "PATIENT",
    "status": "ADD",
    "nomenclatureId": "102691369",
    "reactions": [
      {
        "id": "8ee87e4f-743d-4d9e-aec4-99ceec9e6e94",
        "name": "Skin rash",
        "nomenclatureId": "6ff755b3-0696-4df5-8b2a-a0b118d6e347",
        "createdAt": "2020-01-20T05:40:02.000Z",
        "updatedAt": "2020-01-20T05:40:02.000Z"
      }
    ]
  },
  "procedure": {
    "id": "2a090f43-b746-481f-8ca2-259ea30f08df",
    "name": "Tonsillectomy",
    "comments": "Removed to treat sleep apnea.",
    "createdAt": "2020-01-20T05:40:02.000Z",
    "updatedAt": "2020-01-20T05:40:02.000Z",
    "source": "PATIENT",
    "status": "ADD",
    "approximateDate": "2021-05-29",
    "nomenclatureId": "102691369"
  },
  "medication": {
    "id": "2a090f43-b746-481f-8ca2-259ea30f08df",
    "name": "Medication test name",
    "comments": "Sample medication comment",
    "createdAt": "2020-01-20T05:40:02.000Z",
    "updatedAt": "2020-01-20T05:40:02.000Z",
    "source": "PATIENT",
    "status": "ADD",
    "synonymId": "102691369",
    "dose": "1 tablet",
    "frequency": "Once daily at bedtime.",
    "prescribingProvider": "Provider MD, Test",
    "userStatus": "AS_PRESCRIBED",
    "userStatusLabel": "Taking as shown."
  },
  "immunization": {
    "id": "2a090f43-b746-481f-8ca2-259ea30f08df",
    "name": "Immunization test name",
    "comments": "Sample immunization comment",
    "createdAt": "2020-01-20T05:40:02.000Z",
    "updatedAt": "2020-01-20T05:40:02.000Z",
    "source": "PATIENT",
    "status": "ADD",
    "eventCode": "102691369",
    "approximateDate": "2022-02-24"
  }
}

POST /patients/{patientId}/clipboards/{clipboardId}/sections/{sectionId}/forms/{formId}/items

Creates a patient-entered item (not imported from the EMR) on a clipboard form for the patient.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
patientId	path	string	true	N/A	The unique ID of the patient assigned to the clipboard.	-
clipboardId	path	string	true	N/A	The unique ID of the clipboard assigned to a patient.	-
sectionId	path	string	true	N/A	The unique ID of the section associated with a clipboard.	-
formId	path	string	true	N/A	The unique ID of the form associated with a clipboard section.	-
body	body	postPatientsPatientidClipboardsClipboardidSectionsSectionidFormsFormidItems	true	N/A	No description	-

Response Statuses

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

Schema Definitions

postEventLocations

Name	Type	Required	Description	Accepted Values
name	string	false	The name of the location.	-
names	[object]	false	A list of localized names for the location.	-
» locale	string	true	The locale of the translated attribute.	-
» value	string	true	The value of the translated attribute.	-
description	string	false	The free-text description of the location.	-
descriptions	[object]	false	A list of localized free-text descriptions for the location.	-
» locale	string	true	The locale of the translated attribute.	-
» value	string	true	The value of the translated attribute.	-
address	object	false	The address of the venue where the event is being held.	-
» lines	[string]	false	The lines of the address that indicate the building number, street number, street name, street direction, and similar address information.	-
» city	string	false	The city of the event venue.	-
» district	string	false	The district of the event venue.	-
» state	string	false	The state of the event venue.	-
» country	string	false	The country of the event venue.	-
» postalCode	string	false	The postal code of the event venue.	-
restrictedToCatalogs	[object]	false	References to the catalogs in which the location is grouped.	-
» id	string	true	The ID of the catalog.	-

ConsumerEngagementPublicApi_Entities_V1_Events_Location

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the location.	-
name	string	false	The name of the location.	-
description	string	false	The free-text description of the location.	-
names	[ConsumerEngagementPublicApi_Entities_V1_Events_TranslatedAttribute]	true	A list of localized names for the location.	-
descriptions	[ConsumerEngagementPublicApi_Entities_V1_Events_TranslatedAttribute]	false	A list of localized free-text descriptions for the location.	-
address	ConsumerEngagementPublicApi_Entities_V1_Events_Address	false	The address of the venue where the event is being held.	-
restrictedToCatalogs	[ConsumerEngagementPublicApi_Entities_V1_Events_CatalogReference]	false	References to the catalogs in which the location is grouped.	-

ConsumerEngagementPublicApi_Entities_V1_Events_TranslatedAttribute

Name	Type	Required	Description	Accepted Values
locale	string	true	The locale of the translated attribute.	-
value	string	true	The value of the translated attribute.	-

ConsumerEngagementPublicApi_Entities_V1_Events_Address

Name	Type	Required	Description	Accepted Values
lines	[string]	false	The lines of the address that indicate the building number, street number, street name, street direction, and similar address information.	-
city	string	false	The city of the event venue.	-
district	string	false	The district of the event venue.	-
state	string	false	The state of the event venue.	-
country	string	false	The country of the event venue.	-
postalCode	string	false	The postal code of the event venue.	-

ConsumerEngagementPublicApi_Entities_V1_Events_CatalogReference

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

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

Locations

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

putEventLocations

Name	Type	Required	Description	Accepted Values
name	string	false	The name of the location.	-
names	[object]	false	A list of localized names for the location.	-
» locale	string	true	The locale of the translated attribute.	-
» value	string	true	The value of the translated attribute.	-
description	string	false	The free-text description of the location.	-
descriptions	[object]	false	A list of localized free-text descriptions for the location.	-
» locale	string	true	The locale of the translated attribute.	-
» value	string	true	The value of the translated attribute.	-
address	object	false	The address of the venue where the event is being held.	-
» lines	[string]	false	The lines of the address that indicate the building number, street number, street name, street direction, and similar address information.	-
» city	string	false	The city of the event venue.	-
» district	string	false	The district of the event venue.	-
» state	string	false	The state of the event venue.	-
» country	string	false	The country of the event venue.	-
» postalCode	string	false	The postal code of the event venue.	-
restrictedToCatalogs	[object]	false	References to the catalogs in which the location is grouped.	-
» id	string	true	The ID of the catalog.	-

postEventCategories

Name	Type	Required	Description	Accepted Values
name	string	false	The name of the category.	-
names	[object]	false	A list of localized names for the category.	-
» locale	string	true	The locale of the translated attribute.	-
» value	string	true	The value of the translated attribute.	-
code	object	false	The code of the category from a single, specified code system.	-
» code	string	true	The unique ID of the code.	-
» system	string	true	The ID of the coding system that gives meaning to the code.	-
» display	string	false	A human-readable representation of the code.	-
restrictedToCatalogs	[object]	false	References to the catalogs in which the category is grouped.	-
» id	string	true	The ID of the catalog.	-

ConsumerEngagementPublicApi_Entities_V1_Events_Category

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the category.	-
name	string	false	The name of the category.	-
names	[ConsumerEngagementPublicApi_Entities_V1_Events_TranslatedAttribute]	true	A list of localized names for the category.	-
code	ConsumerEngagementPublicApi_Entities_V1_Events_Code	false	The code of the category from a single, specified code system.	-
restrictedToCatalogs	[ConsumerEngagementPublicApi_Entities_V1_Events_CatalogReference]	false	References to the catalogs in which the category is grouped.	-

ConsumerEngagementPublicApi_Entities_V1_Events_Code

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

putEventCategories

Name	Type	Required	Description	Accepted Values
name	string	false	The name of the category.	-
names	[object]	false	A list of localized names for the category.	-
» locale	string	true	The locale of the translated attribute.	-
» value	string	true	The value of the translated attribute.	-
code	object	false	The code of the category from a single, specified code system.	-
» code	string	true	The unique ID of the code.	-
» system	string	true	The ID of the coding system that gives meaning to the code.	-
» display	string	false	A human-readable representation of the code.	-
restrictedToCatalogs	[object]	false	References to the catalogs in which the category is grouped.	-
» id	string	true	The ID of the catalog.	-

postEventCatalogs

Name	Type	Required	Description	Accepted Values
name	string	true	The name of the catalog.	-
description	string	false	The free-text description of the catalog.	-

ConsumerEngagementPublicApi_Entities_V1_Events_Catalog

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the catalog.	-
name	string	true	The name of the catalog.	-
description	string	false	The free-text description of the catalog.	-

Catalogs

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

putEventCatalogs

Name	Type	Required	Description	Accepted Values
name	string	true	The name of the catalog.	-
description	string	false	The free-text description of the catalog.	-

postEvents

Name	Type	Required	Description	Accepted Values
name	string	false	The name of the event.	-
description	string	false	Additional details about the event that describe the schedule, the intent behind hosting the event, the speakers (if any), and so on.	-
names	[object]	false	A list of localized names for the event.	-
» locale	string	true	The locale of the translated attribute.	-
» value	string	true	The value of the translated attribute.	-
descriptions	[object]	false	A list of localized free-text descriptions for the event.	-
» locale	string	true	The locale of the translated attribute.	-
» value	string	true	The value of the translated attribute.	-
leader	object	true	Information about the individual who will provide guidance and instructions for the event.	-
» name	string	true	The full name of the person who is assigned as the leader of the event or series.	-
» telecoms	[object]	false	The contact details of the person who is assigned as the leader of the event or series.	-
»» system	string	true	The system of the telecom.	EMAIL, PHONE, OTHER
»» value	string	true	The value of the telecom.	-
registrationStatus	string	false	The current registration status of the event. The following statuses are possible: - OPEN: The event has open slots available for registration. - FULL: Registrations for all slots in the event have reached capacity. - CLOSED: The registration period for all slots in the event has ended.	OPEN, FULL, CLOSED
startsAt	string	true	The date and time when the event starts, in ISO 8601 YYYY-MM-DDThh:mm:ssZ format.	-
endsAt	string	true	The date and time when the event ends, in ISO 8601 YYYY-MM-DDThh:mm:ssZ format.	-
timeZone	string	true	The time zone used to configure the start and end times for this event. The value should be a valid Internet Assigned Numbers Authority (IANA) time zone.	-
multislot	boolean	true	Indicates whether the event has the same session hosted multiple times.	-
status	string	false	The current status of the event. The following statuses are possible: - ACTIVE: The event is active. - CANCELED: The event is canceled. If status is updated to CANCELED, it will also update associated event slots to CANCELED.	ACTIVE, CANCELED
location	object	true	The location of the event.	-
» id	string	true	The ID of the location.	-
category	object	true	The category of the event.	-
» id	string	true	The ID of the category.	-
catalogs	[object]	false	References to the catalogs in which the event is grouped.	-
» id	string	true	The ID of the catalog.	-
series	object	false	References to the series to which the event belongs.	-
» id	string	true	The ID of the event series.	-
scopes	[object]	false	A list of references to the scopes in which the event is grouped.	-
» id	string	true	The ID of the scope.	-

ConsumerEngagementPublicApi_Entities_V1_Events_Event

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the event.	-
name	string	false	The name of the event.	-
description	string	false	Additional details about the event that describe the schedule, the intent behind hosting the event, the speakers (if any), and so on.	-
names	[ConsumerEngagementPublicApi_Entities_V1_Events_TranslatedAttribute]	true	A list of localized names for the event.	-
descriptions	[ConsumerEngagementPublicApi_Entities_V1_Events_TranslatedAttribute]	false	A list of localized free-text descriptions for the event.	-
leader	ConsumerEngagementPublicApi_Entities_V1_Events_Leader	true	Information about the individual who will provide guidance and instructions for the event.	-
registrationStatus	string	true	The current registration status of the event. The following statuses are possible: - OPEN: The event has open slots available for registration. - FULL: Registrations for all slots in the event have reached capacity. - CLOSED: The registration period for all slots in the event has ended.	OPEN, FULL, CLOSED
startsAt	string	true	The date and time when the event starts, in ISO 8601 YYYY-MM-DDThh:mm:ssZ format.	-
endsAt	string	true	The date and time when the event ends, in ISO 8601 YYYY-MM-DDThh:mm:ssZ format.	-
timeZone	string	true	The time zone used to configure the start and end times for this event. The value should be a valid Internet Assigned Numbers Authority (IANA) time zone.	-
multislot	boolean	true	Indicates whether the event has the same session hosted multiple times.	-
location	ConsumerEngagementPublicApi_Entities_V1_Events_Location	true	The location of the event.	-
category	ConsumerEngagementPublicApi_Entities_V1_Events_Category	true	The category of the event.	-
catalogs	[ConsumerEngagementPublicApi_Entities_V1_Events_CatalogReference]	false	References to the catalogs in which the event is grouped.	-
series	ConsumerEngagementPublicApi_Entities_V1_Events_SeriesReference	false	References to the series to which the event belongs.	-
scopes	[ConsumerEngagementPublicApi_Entities_V1_Events_ScopeReference]	false	A list of references to the scopes in which the event is grouped.	-
status	string	false	The current status of the event. The following statuses are possible: - ACTIVE: The event is active. - CANCELED: The event is canceled. If status is updated to CANCELED, it will also update associated event slots to CANCELED.	ACTIVE, CANCELED

ConsumerEngagementPublicApi_Entities_V1_Events_Leader

Name	Type	Required	Description	Accepted Values
name	string	true	The full name of the person who is assigned as the leader of the event or series.	-
telecoms	[ConsumerEngagementPublicApi_Entities_V1_Events_Telecom]	false	The contact details of the person who is assigned as the leader of the event or series.	-

ConsumerEngagementPublicApi_Entities_V1_Events_Telecom

Name	Type	Required	Description	Accepted Values
system	string	true	The system of the telecom.	EMAIL, PHONE, OTHER
value	string	true	The value of the telecom.	-

ConsumerEngagementPublicApi_Entities_V1_Events_SeriesReference

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

ConsumerEngagementPublicApi_Entities_V1_Events_ScopeReference

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

Events

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

putEvents

Name	Type	Required	Description	Accepted Values
name	string	false	The name of the event.	-
description	string	false	Additional details about the event that describe the schedule, the intent behind hosting the event, the speakers (if any), and so on.	-
names	[object]	false	A list of localized names for the event.	-
» locale	string	true	The locale of the translated attribute.	-
» value	string	true	The value of the translated attribute.	-
descriptions	[object]	false	A list of localized free-text descriptions for the event.	-
» locale	string	true	The locale of the translated attribute.	-
» value	string	true	The value of the translated attribute.	-
leader	object	true	Information about the individual who will provide guidance and instructions for the event.	-
» name	string	true	The full name of the person who is assigned as the leader of the event or series.	-
» telecoms	[object]	false	The contact details of the person who is assigned as the leader of the event or series.	-
»» system	string	true	The system of the telecom.	EMAIL, PHONE, OTHER
»» value	string	true	The value of the telecom.	-
registrationStatus	string	false	The current registration status of the event. The following statuses are possible: - OPEN: The event has open slots available for registration. - FULL: Registrations for all slots in the event have reached capacity. - CLOSED: The registration period for all slots in the event has ended.	OPEN, FULL, CLOSED
startsAt	string	true	The date and time when the event starts, in ISO 8601 YYYY-MM-DDThh:mm:ssZ format.	-
endsAt	string	true	The date and time when the event ends, in ISO 8601 YYYY-MM-DDThh:mm:ssZ format.	-
timeZone	string	true	The time zone used to configure the start and end times for this event. The value should be a valid Internet Assigned Numbers Authority (IANA) time zone.	-
multislot	boolean	true	Indicates whether the event has the same session hosted multiple times.	-
status	string	false	The current status of the event. The following statuses are possible: - ACTIVE: The event is active. - CANCELED: The event is canceled. If status is updated to CANCELED, it will also update associated event slots to CANCELED.	ACTIVE, CANCELED
location	object	true	The location of the event.	-
» id	string	true	The ID of the location.	-
category	object	true	The category of the event.	-
» id	string	true	The ID of the category.	-
catalogs	[object]	false	References to the catalogs in which the event is grouped.	-
» id	string	true	The ID of the catalog.	-
series	object	false	References to the series to which the event belongs.	-
» id	string	true	The ID of the event series.	-
scopes	[object]	false	A list of references to the scopes in which the event is grouped.	-
» id	string	true	The ID of the scope.	-

postEventsEventidSlots

Name	Type	Required	Description	Accepted Values
description	string	false	Additional details about the event slot that describe the session, schedule, and so on.	-
descriptions	[object]	false	A list of localized free-text descriptions for the event.	-
» locale	string	true	The locale of the translated attribute.	-
» value	string	true	The value of the translated attribute.	-
maxRegistrations	integer(int32)	false	The maximum number of attendees for this session of the event.	-
startsAt	string	true	The date and time when this session of the event starts, in ISO 8601 YYYY-MM-DDThh:mm:ssZ format.	-
endsAt	string	true	The date and time when this session of the event ends, in ISO 8601 YYYY-MM-DDThh:mm:ssZ format.	-
registrationEndsAt	string	false	The date and time when registration for this session of the event ends, in ISO 8601 YYYY-MM-DDThh:mm:ssZ format.	-
timeZone	string	true	The time zone used to configure the start, end, and registration times for this session of the event. The value should be a valid IANA time zone.	-
status	string	false	The current status of the event slot. The following statuses are possible: - ACTIVE: The event slot is active. - CANCELED: The event slot is canceled.	ACTIVE, CANCELED

ConsumerEngagementPublicApi_Entities_V1_Events_Slot

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the event slot.	-
description	string	false	Additional details about the event slot that describe the session, schedule, and so on.	-
descriptions	[ConsumerEngagementPublicApi_Entities_V1_Events_TranslatedAttribute]	false	A list of localized free-text descriptions for the event.	-
maxRegistrations	integer(int32)	false	The maximum number of attendees for this session of the event.	-
availableRegistrations	integer(int32)	false	The number of available registrations for this session of the event. The number of available registrations cannot be less than 0 or greater than the value of the maxRegistrations field. The default value is the value of the maxRegistrations field.	-
startsAt	string	true	The date and time when this session of the event starts, in ISO 8601 YYYY-MM-DDThh:mm:ssZ format.	-
endsAt	string	true	The date and time when this session of the event ends, in ISO 8601 YYYY-MM-DDThh:mm:ssZ format.	-
registrationEndsAt	string	false	The date and time when registration for this session of the event ends, in ISO 8601 YYYY-MM-DDThh:mm:ssZ format.	-
timeZone	string	true	The time zone used to configure the start, end, and registration times for this session of the event. The value should be a valid IANA time zone.	-
status	string	false	The current status of the event slot. The following statuses are possible: - ACTIVE: The event slot is active. - CANCELED: The event slot is canceled.	ACTIVE, CANCELED

Slots

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

putEventsEventidSlots

Name	Type	Required	Description	Accepted Values
description	string	false	Additional details about the event slot that describe the session, schedule, and so on.	-
descriptions	[object]	false	A list of localized free-text descriptions for the event.	-
» locale	string	true	The locale of the translated attribute.	-
» value	string	true	The value of the translated attribute.	-
maxRegistrations	integer(int32)	false	The maximum number of attendees for this session of the event.	-
startsAt	string	true	The date and time when this session of the event starts, in ISO 8601 YYYY-MM-DDThh:mm:ssZ format.	-
endsAt	string	true	The date and time when this session of the event ends, in ISO 8601 YYYY-MM-DDThh:mm:ssZ format.	-
registrationEndsAt	string	false	The date and time when registration for this session of the event ends, in ISO 8601 YYYY-MM-DDThh:mm:ssZ format.	-
timeZone	string	true	The time zone used to configure the start, end, and registration times for this session of the event. The value should be a valid IANA time zone.	-
status	string	false	The current status of the event slot. The following statuses are possible: - ACTIVE: The event slot is active. - CANCELED: The event slot is canceled.	ACTIVE, CANCELED

postEventSlots

Name	Type	Required	Description	Accepted Values
slots	[object]	true	A grouping of event slots.	-
» event	object	true	The ID of the event.	-
»» id	string	true	The ID of the event.	-
» descriptions	[object]	false	A list of localized free-text descriptions for the slot.	-
»» locale	string	true	The locale of the translated attribute.	-
»» value	string	true	The value of the translated attribute.	-
» maxRegistrations	integer(int32)	false	The maximum number of attendees for this session of the event.	-
» startsAt	string	true	The date and time when this session of the event starts, in ISO 8601 YYYY-MM-DDThh:mm:ssZ format.	-
» endsAt	string	true	The date and time when this session of the event ends, in ISO 8601 YYYY-MM-DDThh:mm:ssZ format.	-
» registrationEndsAt	string	false	The date and time when registration for this session of the event ends, in ISO 8601 YYYY-MM-DDThh:mm:ssZ format.	-
» timeZone	string	true	The time zone used to configure the start, end, and registration times for this session of the event. The value should be a valid IANA time zone.	-
» status	string	false	The current status of the event slot. The following statuses are possible: - ACTIVE: The event slot is active. - CANCELED: The event slot is canceled.	ACTIVE, CANCELED

ConsumerEngagementPublicApi_Entities_V1_Events_EventSlotList

Name	Type	Required	Description	Accepted Values
slots	[ConsumerEngagementPublicApi_Entities_V1_Events_EventSlot]	true	A grouping of event slots.	-

ConsumerEngagementPublicApi_Entities_V1_Events_EventSlot

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the event slot.	-
event	ConsumerEngagementPublicApi_Entities_V1_Events_SlotEventReference	true	The ID of the corresponding slot’s event.	-
descriptions	[ConsumerEngagementPublicApi_Entities_V1_Events_TranslatedAttribute]	false	A list of localized free-text descriptions for the slot.	-
maxRegistrations	integer(int32)	false	The maximum number of attendees for this session of the event.	-
availableRegistrations	integer(int32)	false	The number of available registrations for this session of the event. The number of available registrations cannot be less than 0 or greater than the value of the maxRegistrations field. The default value is the value of the maxRegistrations field.	-
startsAt	string	true	The date and time when this session of the event starts, in ISO 8601 YYYY-MM-DDThh:mm:ssZ format.	-
endsAt	string	true	The date and time when this session of the event ends, in ISO 8601 YYYY-MM-DDThh:mm:ssZ format.	-
registrationEndsAt	string	false	The date and time when registration for this session of the event ends, in ISO 8601 YYYY-MM-DDThh:mm:ssZ format.	-
timeZone	string	true	The time zone used to configure the start, end, and registration times for this session of the event. The value should be a valid IANA time zone.	-
status	string	false	The current status of the event slot. The following statuses are possible: - ACTIVE: The event slot is active. - CANCELED: The event slot is canceled.	ACTIVE, CANCELED

ConsumerEngagementPublicApi_Entities_V1_Events_SlotEventReference

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

postEventSeries

Name	Type	Required	Description	Accepted Values
name	string	false	The name of the event series.	-
description	string	false	Additional details about the event series that describe the sessions, schedule, the intent behind hosting the series, the speakers (if any), and so on.	-
names	[object]	false	A list of localized names for the series.	-
» locale	string	true	The locale of the translated attribute.	-
» value	string	true	The value of the translated attribute.	-
descriptions	[object]	false	A list of localized free-text descriptions for the series.	-
» locale	string	true	The locale of the translated attribute.	-
» value	string	true	The value of the translated attribute.	-
leader	object	false	Information about the individual who will provide guidance and instructions for the series.	-
» name	string	true	The full name of the person who is assigned as the leader of the event or series.	-
» telecoms	[object]	false	The contact details of the person who is assigned as the leader of the event or series.	-
»» system	string	true	The system of the telecom.	EMAIL, PHONE, OTHER
»» value	string	true	The value of the telecom.	-
registrationStatus	string	false	The current registration status of the event series. The following statuses are possible: - OPEN: The series has events with open slots available for registration. - FULL: Registrations for all slots for at least one event in the series have reached capacity. - CLOSED: The registration period for all slots for at least one event in the series has ended.	OPEN, FULL, CLOSED
status	string	false	The current status of the series. The following statuses are possible: - ACTIVE: The series is active. - CANCELED: The series is canceled. If status is updated to CANCELED, it will also update associated events and event slots to CANCELED.	ACTIVE, CANCELED
catalogs	[object]	false	References to the catalogs in which the series is grouped.	-
» id	string	true	The ID of the catalog.	-
scopes	[object]	false	A list of references to the scopes in which the series is grouped.	-
» id	string	true	The ID of the scope.	-

ConsumerEngagementPublicApi_Entities_V1_Events_Series

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the event series.	-
name	string	false	The name of the event series.	-
description	string	false	Additional details about the event series that describe the sessions, schedule, the intent behind hosting the series, the speakers (if any), and so on.	-
names	[ConsumerEngagementPublicApi_Entities_V1_Events_TranslatedAttribute]	true	A list of localized names for the series.	-
descriptions	[ConsumerEngagementPublicApi_Entities_V1_Events_TranslatedAttribute]	false	A list of localized free-text descriptions for the series.	-
registrationStatus	string	true	The current registration status of the event series. The following statuses are possible: - OPEN: The series has events with open slots available for registration. - FULL: Registrations for all slots for at least one event in the series have reached capacity. - CLOSED: The registration period for all slots for at least one event in the series has ended.	OPEN, FULL, CLOSED
leader	ConsumerEngagementPublicApi_Entities_V1_Events_Leader	false	Information about the individual who will provide guidance and instructions for the series.	-
catalogs	[ConsumerEngagementPublicApi_Entities_V1_Events_CatalogReference]	false	References to the catalogs in which the series is grouped.	-
scopes	[ConsumerEngagementPublicApi_Entities_V1_Events_ScopeReference]	false	A list of references to the scopes in which the series is grouped.	-
status	string	false	The current status of the series. The following statuses are possible: - ACTIVE: The series is active. - CANCELED: The series is canceled. If status is updated to CANCELED, it will also update associated events and event slots to CANCELED.	ACTIVE, CANCELED

Series

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

putEventSeries

Name	Type	Required	Description	Accepted Values
name	string	false	The name of the event series.	-
description	string	false	Additional details about the event series that describe the sessions, schedule, the intent behind hosting the series, the speakers (if any), and so on.	-
names	[object]	false	A list of localized names for the series.	-
» locale	string	true	The locale of the translated attribute.	-
» value	string	true	The value of the translated attribute.	-
descriptions	[object]	false	A list of localized free-text descriptions for the series.	-
» locale	string	true	The locale of the translated attribute.	-
» value	string	true	The value of the translated attribute.	-
leader	object	false	Information about the individual who will provide guidance and instructions for the series.	-
» name	string	true	The full name of the person who is assigned as the leader of the event or series.	-
» telecoms	[object]	false	The contact details of the person who is assigned as the leader of the event or series.	-
»» system	string	true	The system of the telecom.	EMAIL, PHONE, OTHER
»» value	string	true	The value of the telecom.	-
registrationStatus	string	false	The current registration status of the event series. The following statuses are possible: - OPEN: The series has events with open slots available for registration. - FULL: Registrations for all slots for at least one event in the series have reached capacity. - CLOSED: The registration period for all slots for at least one event in the series has ended.	OPEN, FULL, CLOSED
status	string	false	The current status of the series. The following statuses are possible: - ACTIVE: The series is active. - CANCELED: The series is canceled. If status is updated to CANCELED, it will also update associated events and event slots to CANCELED.	ACTIVE, CANCELED
catalogs	[object]	false	References to the catalogs in which the series is grouped.	-
» id	string	true	The ID of the catalog.	-
scopes	[object]	false	A list of references to the scopes in which the series is grouped.	-
» id	string	true	The ID of the scope.	-

postEventRegistrations

Name	Type	Required	Description	Accepted Values
consumer	object	true	A reference to the Health Data Intelligence consumer who registered for the event.	-
» id	string	true	The ID of the Health Data Intelligence consumer.	-
slot	object	true	A reference to the event slot for which the Health Data Intelligence consumer registered.	-
» id	string	true	The ID of the event slot.	-
» event	object	true	A reference to the event to which this slot belongs.	-
»» id	string	true	The ID of the event.	-
»» seriesId	string	false	The ID of the event series.	-

ConsumerEngagementPublicApi_Entities_V1_Events_Registration

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the event registration.	-
consumer	ConsumerEngagementPublicApi_Entities_V1_Events_ConsumerReference	true	A reference to the Health Data Intelligence consumer who registered for the event.	-
slot	ConsumerEngagementPublicApi_Entities_V1_Events_SlotReference	true	A reference to the event slot for which the Health Data Intelligence consumer registered.	-

ConsumerEngagementPublicApi_Entities_V1_Events_ConsumerReference

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

ConsumerEngagementPublicApi_Entities_V1_Events_SlotReference

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the event slot.	-
event	ConsumerEngagementPublicApi_Entities_V1_Events_EventReference	true	A reference to the event to which this slot belongs.	-

ConsumerEngagementPublicApi_Entities_V1_Events_EventReference

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the event.	-
seriesId	string	false	The ID of the event series.	-

Registrations

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

postEventAttendances

Name	Type	Required	Description	Accepted Values
attendances	[object]	true	A list of Event attendances.	-
» consumer	object	true	A reference to the Health Data Intelligence consumer who attended the event.	-
»» id	string	true	The ID of the Health Data Intelligence consumer.	-
» slot	object	true	A reference to the event slot that the Health Data Intelligence consumer attended.	-
»» id	string	true	The ID of the event slot.	-
»» event	object	true	A reference to the event to which this slot belongs.	-
»»» id	string	true	The ID of the event.	-
»»» seriesId	string	false	The ID of the event series.	-

ConsumerEngagementPublicApi_Entities_V1_Events_AttendanceList

Name	Type	Required	Description	Accepted Values
attendances	[ConsumerEngagementPublicApi_Entities_V1_Events_Attendance]	true	A list of Event attendances.	-

ConsumerEngagementPublicApi_Entities_V1_Events_Attendance

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the event attendance.	-
consumer	ConsumerEngagementPublicApi_Entities_V1_Events_ConsumerReference	true	A reference to the Health Data Intelligence consumer who attended the event.	-
slot	ConsumerEngagementPublicApi_Entities_V1_Events_SlotReference	true	A reference to the event slot that the Health Data Intelligence consumer attended.	-

Attendances

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

postEventScopes

Name	Type	Required	Description	Accepted Values
name	string	true	The name of the scope.	-
kind	string	false	The free-text description of the scope.	-
consumerGroups	[object]	false	A list of consumer groups for the scope.	-
» id	string	true	A consumer group reference ID for a scope.	-

ConsumerEngagementPublicApi_Entities_V1_Events_Scope

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the scope.	-
name	string	true	The name of the scope.	-
kind	string	false	The free-text description of the scope.	-
consumerGroups	[ConsumerEngagementPublicApi_Entities_V1_Events_ConsumerGroupReference]	false	A list of consumer groups for the scope.	-

ConsumerEngagementPublicApi_Entities_V1_Events_ConsumerGroupReference

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

Scopes

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

putEventScopes

Name	Type	Required	Description	Accepted Values
name	string	true	The name of the scope.	-
kind	string	false	The free-text description of the scope.	-
consumerGroups	[object]	false	A list of consumer groups for the scope.	-
» id	string	true	A consumer group reference ID for a scope.	-

postEventEmailNotifications

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

ConsumerEngagementPublicApi_Entities_V1_Events_EventEmailNotification

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of an event email notification.	-
locale	string	true	The locale for which an event email notification is configured.	-
eventId	string	true	The ID of the event for which an event email notification is configured.	-
emailSubject	string	true	The subject of an event email notification.	-
emailBody	string	true	The body of an event email notification. The body is sent in HTML format.	-
sendNotificationOn	string(date)	true	The date on which an event email notification should be sent in ISO 8601 YYYY-MM-DD format.	-
notificationStatus	string	false	The current status of an event email notification. The default status value is `NOT_SENT`.	SENT, IN_PROGRESS, NOT_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.	-
createdAt	string(date-time)	true	The date and time when an event 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 event 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 event 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.	-

EventEmailNotifications

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

putEventEmailNotifications

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

postLearningModules

Name	Type	Required	Description	Accepted Values
definitionId	string	true	The definition ID of a learning module.	-
imageUrl	string	false	An image URL for a wellness learning module.	-
title	[object]	true	A list of learning module titles for different locales.	-
» locale	string	true	The locale. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen, for example, `en-US`.	-
» text	string	true	The title of the learning module for a given locale.	-
description	[object]	false	A list of learning module descriptions for a different locale.	-
» locale	string	true	The locale. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen, for example, `en-US`.	-
» text	string	true	The descriptions of the learning module for a given locale.	-
keywords	[object]	false	A list of learning module keywords for different locales.	-
» locale	string	true	The locale. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen, for example, `en-US`.	-
» text	[string]	true	The keywords of the learning module for a given locale.	-
categories	[string]	false	A list of category IDs for the learning module.	-
catalogs	[object]	false	A list of catalogs for the learning modules	-
» id	string	true	A catalog reference ID for a learning module.	-
consumerGroups	[object]	false	A list of consumer groups for the learning modules.	-
» id	string	true	A consumer group reference ID for a learning module.	-

ConsumerEngagementPublicApi_Entities_V1_LearningModules_Module

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the module.	-
definitionId	string	true	The ID of the definition of the learning module.	-
title	[ConsumerEngagementPublicApi_Entities_V1_LearningModules_Locale]	true	The title of the learning module.	-
description	[ConsumerEngagementPublicApi_Entities_V1_LearningModules_Locale]	false	The description of the learning module.	-
status	string	false	The status of the learning module. The default value for a new learning module is DRAFT.	DRAFT, PUBLISHED, RETIRED
type	string	false	The type of learning module. Standard modules are default modules that are available to all tenants. Custom modules are created by each individual tenant.	STANDARD, CUSTOM
imageUrl	string	false	The image URL of the learning module.	-
keywords	[string]	false	The keywords of the learning module.	-
categories	[string]	false	The categories of the learning module.	-
catalogs	[ConsumerEngagementPublicApi_Entities_V1_LearningModules_LearningModuleCatalogReference]	false	The catalogs of the learning module.	-
consumerGroups	[ConsumerEngagementPublicApi_Entities_V1_LearningModules_ConsumerGroupReference]	false	The consumer groups of the learning module.	-
createdAt	string(date-time)	false	The date and time when the module was created, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-
updatedAt	string(date-time)	false	The date and time when module was last updated, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-

ConsumerEngagementPublicApi_Entities_V1_LearningModules_Locale

Name	Type	Required	Description	Accepted Values
locale	string	true	The locale.	-
text	string	true	The text in the locale.	-

ConsumerEngagementPublicApi_Entities_V1_LearningModules_LearningModuleCatalogReference

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

ConsumerEngagementPublicApi_Entities_V1_LearningModules_ConsumerGroupReference

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

TranslatedModules

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

ConsumerEngagementPublicApi_Entities_V1_LearningModules_TranslatedModule

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the module.	-
title	[string]	true	The title of the learning module.	-
description	[string]	false	The description of the learning module.	-
status	string	false	The status of the learning module.	DRAFT, PUBLISHED, RETIRED
type	string	false	The type of learning module. Standard modules are default modules that are available to all tenants. Custom modules are created by each individual tenant.	STANDARD, CUSTOM
imageUrl	string	false	The image URL of the learning module.	-
keywords	[string]	false	The keywords of the learning module.	-
categories	[string]	false	The categories of the learning module.	-
catalogs	[ConsumerEngagementPublicApi_Entities_V1_LearningModules_LearningModuleCatalogReference]	false	The catalogs of the learning module.	-
consumerGroups	[ConsumerEngagementPublicApi_Entities_V1_LearningModules_ConsumerGroupReference]	false	The consumer groups of the learning module.	-
createdAt	string(date-time)	false	The date and time when the module was created, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-
updatedAt	string(date-time)	false	The date and time when module was last updated, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-

patchLearningModules

Name	Type	Required	Description	Accepted Values
imageUrl	string	false	An image URL for a wellness learning module.	-
status	string	false	The status of the learning module. This can be either DRAFT, PUBLISHED, or RETIRED.	-
title	[object]	false	A list of learning module titles for different locales.	-
» locale	string	true	The locale. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen, for example, `en-US`.	-
» text	string	true	The title of the learning module for a given locale.	-
description	[object]	false	A list of learning module descriptions for different locales.	-
» locale	string	true	The locale. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen, for example, `en-US`.	-
» text	string	true	The descriptions of the learning module for a given locale.	-
keywords	[object]	false	A list of learning module keywords for different locales.	-
» locale	string	true	The locale. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen, for example, `en-US`.	-
» text	[string]	true	The keywords of the learning module for a given locale.	-
categories	[string]	false	A list of category IDs for the learning module.	-
catalogs	[object]	false	A list of catalogs for the learning modules.	-
» id	string	true	A catalog reference ID for a learning module.	-
consumerGroups	[object]	false	A list of consumer groups for the learning modules.	-
» id	string	true	A consumer group reference ID for a learning module.	-

postLearningModulesModuleidTasks

Name	Type	Required	Description	Accepted Values
title	[object]	true	The title of the task.	-
» locale	string	true	The locale. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen, for example, `en-US`.	-
» text	string	true	The title of the task for a given locale.	-
description	[object]	false	The description of the task.	-
» locale	string	true	The locale. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen, for example, `en-US`.	-
» text	string	true	The description of the task for a given locale.	-
sourceReference	object	true	The source reference ID and type in an external system, for example, an education library, questionnaire, or tracker.	-
» id	string	true	The source ID in an external system	-
» kind	string	true	The source type in an external system, for example, `wellness#education` and `wellness#tracker`.	-
order	integer(int32)	true	The task order of the learning module.	-
weeksBeforeActive	integer(int32)	false	The number of weeks from when the user enrolled before they can complete the task.	-

ConsumerEngagementPublicApi_Entities_V1_LearningModules_Task

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the task.	-
moduleReference	string	true	The ID of the learning module.	-
title	[ConsumerEngagementPublicApi_Entities_V1_LearningModules_Locale]	true	The title of the task.	-
description	[ConsumerEngagementPublicApi_Entities_V1_LearningModules_Locale]	false	The description of the task.	-
sourceReference	string	false	The ID of the task in an external source system.	-
order	integer(int32)	true	The order of the tasks in the learning module.	-
weeksBeforeActive	integer(int32)	false	The number of weeks from when the user enrolled before they can complete the task.	-
createdAt	string(date-time)	false	The date and time when the task was created, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-
updatedAt	string(date-time)	false	The date and time when the task was last updated, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-

Tasks

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

patchLearningModulesModuleidTasks

Name	Type	Required	Description	Accepted Values
title	[object]	false	The title of the task.	-
» locale	string	true	The locale. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen, for example, `en-US`.	-
» text	string	true	The title of the task for a given locale.	-
sourceReference	object	false	The source reference ID and type in an external system, for example, an education library, questionnaire, or tracker.	-
» id	string	true	The source ID in an external system.	-
» kind	string	true	The source type in an external system, for example, `wellness#education` and `wellness#tracker`.	-
order	integer(int32)	false	The task order of the learning module.	-
weeksBeforeActive	integer(int32)	false	The number of weeks from when the user enrolled before they can complete the task.	-
description	[object]	false	The description of the task.	-
» locale	string	true	The locale. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen, for example, `en-US`.	-
» text	string	true	The description of the task for a given locale.	-

postLearningModuleEnrollments

Name	Type	Required	Description	Accepted Values
moduleReferenceId	string	true	The learning module ID. The maximum length is 36 characters.	-
consumerReferenceId	string	true	The Health Data Intelligence consumer ID. See Consumer API for more information.	-

ConsumerEngagementPublicApi_Entities_V1_LearningModules_Enrollment

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the enrollment.	-
consumerReference	string	true	The ID of the consumer.	-
moduleReference	string	true	The ID of the learning module.	-
status	string	true	The enrollment status.	-
createdAt	string(date-time)	false	The date and time when the enrollment was created, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-
updatedAt	string(date-time)	false	The date and time when enrollment was last updated, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-

Enrollments

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

EnrollmentTasks

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

ConsumerEngagementPublicApi_Entities_V1_LearningModules_EnrollmentTask

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the task.	-
moduleTaskReference	string	true	The ID of the enrolled task.	-
status	string	true	The enrolled task status of the learning module.	-
order	string	true	The order of tasks in the learning module.	-
taskActivity	string	false	The ID of the qualifying consumer activity in the source system, for example, a questionnaire response or quiz response.	-
createdAt	string(date-time)	false	The date and time when the task was created, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-
updatedAt	string(date-time)	false	The date and time when the task was last updated, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-

patchLearningModuleEnrollmentsEnrollmentidTasks

Name	Type	Required	Description	Accepted Values
status	string	true	The status of the learning module task.	-
taskActivity	object	false	A Health Data Intelligence consumer activity source ID. The maximum length is 36 characters.	-
» id	string	true	The source ID in an external system.	-

postLearningModuleCategories

Name	Type	Required	Description	Accepted Values
title	[object]	true	The title of the category in a different locale.	-
» locale	string	true	The locale. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen, for example, `en-US`.	-
» text	string	true	The title of the category in the locale.	-

ConsumerEngagementPublicApi_Entities_V1_LearningModules_LearningModuleCategory

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the category.	-
title	[ConsumerEngagementPublicApi_Entities_V1_LearningModules_Locale]	true	The category title in a different locale.	-
createdAt	string(date-time)	false	The date and time when the module was created, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-
updatedAt	string(date-time)	false	The date and time when the module was last updated, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-

LearningModuleCategories

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

patchLearningModuleCategories

Name	Type	Required	Description	Accepted Values
title	[object]	false	The title of the category in a different locale.	-
» locale	string	true	The locale. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen, for example, `en-US`.	-
» text	string	true	The title of the category in the locale.	-

postLearningModuleCatalogs

Name	Type	Required	Description	Accepted Values
name	string	true	The name of the catalog.	-
description	string	false	The free-text description of the catalog.	-

ConsumerEngagementPublicApi_Entities_V1_LearningModules_LearningModuleCatalog

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the catalog.	-
name	string	true	The name of the catalog.	-
description	string	false	The free-text description of the catalog.	-

LearningModuleCatalogs

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

putLearningModuleCatalogs

Name	Type	Required	Description	Accepted Values
name	string	true	The name of the catalog.	-
description	string	false	The free-text description of the catalog.	-

postChallenges

Name	Type	Required	Description	Accepted Values
names	[object]	true	A list of names for the challenge in different locales.	-
» text	string	true	The localized name of the challenge.	-
» locale	string	true	The locale for the challenge name. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen (-), for example, `en-US`.	-
descriptions	[object]	false	A list of descriptions for the challenge in different locales.	-
» text	string	true	The localized description of the challenge.	-
» locale	string	true	The locale for the challenge description. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen (-), for example, `en-US`.	-
consumerGroups	[object]	false	The consumer groups of the challenge.	-
» id	string	true	The ID of the consumer group.	-
imageURL	string	false	The URL of the marketing image for the challenge.	-
startsAt	string(date-time)	true	The start date and time for the challenge displayed in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-
endsAt	string(date-time)	true	The end date and time for the challenge displayed in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-
registrationStartsAt	string(date-time)	true	The date and time when consumers can start to register for the challenge displayed in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-
registrationEndsAt	string(date-time)	true	The date and time after which consumers can no longer register for the challenge displayed in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-
timeZone	string	true	The time zone used to configure the start and end times for the challenge. This value must match a valid time zone in the IANA database.	-
catalogs	[object]	true	The IDs of one or more catalogs with which the challenge is associated.	-
» id	string	true	The ID of a challenge catalog.	-
goals	[object]	true	The IDs of one or more goals associated with the challenge.	-
» id	string	true	The ID of a goal for the challenge.	-
completionCriteria	[object]	true	A list of criteria to determine whether the consumer has completed the challenge.	-
» goal	object	true	The goal linked to the completion criteria.	-
»» id	string	true	The ID of the goal	-
» value	number(float)	true	The value to be used when determining whether the consumer has completed the challenge.	-
» timesGoalMet	integer(int32)	true	The number of times a consumer must meet the goal in the specified interval.	-
» interval	string	true	The interval on which the consumer must meet the goal.	WEEKLY, CHALLENGE_DURATION

ConsumerEngagementPublicApi_Entities_V1_Challenges_Challenge

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the challenge.	-
names	ConsumerEngagementPublicApi_Entities_V1_Challenges_Translation	true	A list of localized names for the challenge.	-
descriptions	ConsumerEngagementPublicApi_Entities_V1_Challenges_Translation	false	A list of localized descriptions for the challenge.	-
consumerGroups	[ConsumerEngagementPublicApi_Entities_V1_Challenges_ConsumerGroup]	false	The consumer groups of the challenge.	-
imageURL	string	false	The URL of the marketing image for the challenge.	-
startsAt	string(date-time)	true	The start date and time for the challenge displayedin ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-
endsAt	string(date-time)	true	The end date and time for the challenge displayed in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-
registrationStartsAt	string(date-time)	true	The date and time when consumers can start to register for the challenge displayed in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-
registrationEndsAt	string(date-time)	true	The date and time after which consumers can no longer register for the challenge displayed in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-
timeZone	string	true	The time zone used to configure the start and end times for the challenge. This value matches a valid time zone in the IANA database.	-
catalogs	[ConsumerEngagementPublicApi_Entities_V1_Challenges_Catalog]	true	A list of catalogs with which the challenge is associated.	-
goals	[ConsumerEngagementPublicApi_Entities_V1_Challenges_Goal]	true	A list of goals for the challenge.	-
completionCriteria	[ConsumerEngagementPublicApi_Entities_V1_Challenges_CompletionCriteria]	true	The criteria used to determine whether the consumer has completed the challenge. If multiple completion criteria are present, the consumer must meet all of them.	-
createdAt	string(date-time)	true	The date and time when the challenge request was created in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-
updatedAt	string(date-time)	true	The date and time when the challenge was last updated in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-

ConsumerEngagementPublicApi_Entities_V1_Challenges_Translation

Name	Type	Required	Description	Accepted Values
text	string	true	The text of the translation.	-
locale	string	true	The locale of the translation.	-

ConsumerEngagementPublicApi_Entities_V1_Challenges_ConsumerGroup

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

ConsumerEngagementPublicApi_Entities_V1_Challenges_Catalog

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the challenge catalog.	-
names	ConsumerEngagementPublicApi_Entities_V1_Challenges_Translation	true	A list of localized names for the challenge catalog.	-
descriptions	ConsumerEngagementPublicApi_Entities_V1_Challenges_Translation	false	A list of localized descriptions for the challenge catalog.	-

ConsumerEngagementPublicApi_Entities_V1_Challenges_Goal

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of a challenge goal.	-
names	ConsumerEngagementPublicApi_Entities_V1_Challenges_Translation	true	A list of localized names for the challenge goal.	-
descriptions	ConsumerEngagementPublicApi_Entities_V1_Challenges_Translation	false	A list of localized descriptions for the challenge goal.	-
type	string	true	The type of challenge.	STEPS, PHYSICAL_ACTIVITY, WATER, NUTRITION
value	integer(int32)	true	The total value that must be met over the specified frequency to complete the goal successfully.	-
unit	string	true	The units for the challenge.	STEPS, MINUTES, DAYS_LOGGED, OUNCES
frequency	string	true	The frequency on which the consumer must meet the goal.	ONE_TIME, DAILY, WEEKLY
isAffirmative	boolean	false	Indicates whether the goal is an affirmative type. Affirmative goals are generally used in scenarios where the completion of a goal does not have a specific value and cannot be automatically tracked by fitness devices. For example, you can create an Intermittent Fasting goal as an Affirmative goal, and users registered in the challenge can track and affirm to the goal as complete on days they met the goal. If `isAffirmative` is not provided, this value defaults defaults to `false`.	-
coding	ConsumerEngagementPublicApi_Entities_V1_Challenges_Coding	false	No description	-
createdAt	string(date-time)	true	The date and time when the challenge goal request was created. This value is displayed in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-
updatedAt	string(date-time)	true	The date and time when the challenge goal was last updated. This value is displayed in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-

ConsumerEngagementPublicApi_Entities_V1_Challenges_Coding

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

ConsumerEngagementPublicApi_Entities_V1_Challenges_CompletionCriteria

Name	Type	Required	Description	Accepted Values
goal	object	true	The goal linked to the completion criteria.	-
value	number(float)	false	The value to be used when determining whether a consumer has met the completion criteria.	-
timesGoalMet	integer(int32)	true	The number of times a consumer must meet the goal in the specified interval.	-
interval	string	true	The interval on which the consumer must meet the goal.	WEEKLY, CHALLENGE_DURATION

Challenges

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

putChallenges

Name	Type	Required	Description	Accepted Values
names	[object]	true	A list of names for the challenge in different locales.	-
» text	string	true	The localized name of the challenge.	-
» locale	string	true	The locale for the challenge name. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen (-), for example, `en-US`.	-
descriptions	[object]	false	A list of descriptions for the challenge in different locales.	-
» text	string	true	The localized description of the challenge.	-
» locale	string	true	The locale for the challenge description. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen (-), for example, `en-US`.	-
consumerGroups	[object]	false	The consumer groups of the challenge.	-
» id	string	true	The ID of the consumer group.	-
imageURL	string	false	The URL of the marketing image for the challenge.	-
startsAt	string(date-time)	true	The start date and time for the challenge displayed in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-
endsAt	string(date-time)	true	The end date and time for the challenge displayed in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-
registrationStartsAt	string(date-time)	true	The date and time when consumers can start to register for the challenge displayed in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-
registrationEndsAt	string(date-time)	true	The date and time after which consumers can no longer register for the challenge displayed in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-
timeZone	string	true	The time zone used to configure the start and end times for the challenge. This value must match a valid time zone in the IANA database.	-
catalogs	[object]	true	The IDs of one or more catalogs with which the challenge is associated.	-
» id	string	true	The ID of a challenge catalog.	-
goals	[object]	true	The IDs of one or more goals associated with the challenge.	-
» id	string	true	The ID of a goal for the challenge.	-
completionCriteria	[object]	true	A list of criteria to determine whether the consumer has completed the challenge.	-
» goal	object	true	The goal linked to the completion criteria.	-
»» id	string	true	The ID of the goal	-
» value	number(float)	true	The value to be used when determining whether the consumer has completed the challenge.	-
» timesGoalMet	integer(int32)	true	The number of times a consumer must meet the goal in the specified interval.	-
» interval	string	true	The interval on which the consumer must meet the goal.	WEEKLY, CHALLENGE_DURATION

postTeamChallenges

Name	Type	Required	Description	Accepted Values
names	[object]	true	A list of names for the challenge in different locales.	-
» text	string	true	The localized name of the challenge.	-
» locale	string	true	The locale for the challenge name. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen (-), for example, `en-US`.	-
descriptions	[object]	false	A list of descriptions for the challenge in different locales.	-
» text	string	true	The localized description of the challenge.	-
» locale	string	true	The locale for the challenge description. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen (-), for example, `en-US`.	-
consumerGroups	[object]	false	The consumer groups of the challenge.	-
» id	string	true	The ID of the consumer group.	-
imageURL	string	false	The URL of the marketing image for the challenge.	-
startsAt	string(date-time)	true	The start date and time for the challenge, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-
endsAt	string(date-time)	true	The end date and time for the challenge, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-
registrationStartsAt	string(date-time)	true	The date and time for when consumers can start to register for the challenge, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-
registrationEndsAt	string(date-time)	true	The date and time after which consumers can no longer register for the challenge, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-
canConsumerCreateTeam	boolean	false	Indicates whether consumers belonging to a team challenge are allowed to create their own team. This value defaults to `false` if not passed.	-
timeZone	string	true	The time zone used to configure the start and end times for the challenge. This value should match a valid time zone in the Internet Assigned Numbers Authority (IANA) database.	-
maxTeamRegistrations	integer(int32)	false	The maximum number of registrations allowed in a team. By default, this value is set to null which means there is no limit and any number of consumers can register in a team.	-
catalogs	[object]	true	The IDs of one or more catalogs with which the challenge is associated.	-
» id	string	true	The ID of a challenge catalog.	-
goals	[object]	true	The IDs of one or more goals associated with the challenge.	-
» id	string	true	The ID of a goal for the challenge.	-

ConsumerEngagementPublicApi_Entities_V1_Challenges_TeamChallenge

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the team challenge.	-
names	ConsumerEngagementPublicApi_Entities_V1_Challenges_Translation	true	A list of localized names for the team challenge.	-
descriptions	ConsumerEngagementPublicApi_Entities_V1_Challenges_Translation	false	A list of localized descriptions for the team challenge.	-
consumerGroups	[ConsumerEngagementPublicApi_Entities_V1_Challenges_ConsumerGroup]	false	The consumer groups of the team challenge.	-
imageURL	string	false	The URL of the marketing image for the team challenge.	-
startsAt	string(date-time)	true	The start date and time for the team challenge in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-
endsAt	string(date-time)	true	The end date and time for the team challenge in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-
registrationStartsAt	string(date-time)	true	The date and time when consumers can start to register for the team challenge in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-
registrationEndsAt	string(date-time)	true	The date and time after which consumers can no longer register for the team challenge, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-
canConsumerCreateTeam	boolean	false	Indicates whether consumers belonging to a team challenge are allowed to create their own team. Defaults to false if not passed	-
timeZone	string	true	The time zone used to configure the start and end times for the team challenge. This value matches a valid time zone in the Internet Assigned Numbers Authority (IANA) database.	-
maxTeamRegistrations	integer(int32)	false	The maximum number of registrations allowed in a team. By default, this value is set to null which means there is no limit and any number of consumers can register in a team.	-
catalogs	[ConsumerEngagementPublicApi_Entities_V1_Challenges_Catalog]	true	A list of catalogs with which the team challenge is associated.	-
goals	[ConsumerEngagementPublicApi_Entities_V1_Challenges_Goal]	true	A list of goals for the team challenge.	-
createdAt	string(date-time)	true	The date and time when the team challenge request was created in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-
updatedAt	string(date-time)	true	The date and time when the team challenge was last updated in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-

TeamChallenges

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

putTeamChallenges

Name	Type	Required	Description	Accepted Values
names	[object]	true	A list of names for the challenge in different locales.	-
» text	string	true	The localized name of the challenge.	-
» locale	string	true	The locale for the challenge name. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen (-), for example, `en-US`.	-
descriptions	[object]	false	A list of descriptions for the challenge in different locales.	-
» text	string	true	The localized description of the challenge.	-
» locale	string	true	The locale for the challenge description. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen (-), for example, `en-US`.	-
consumerGroups	[object]	false	The consumer groups of the challenge.	-
» id	string	true	The ID of the consumer group.	-
imageURL	string	false	The URL of the marketing image for the challenge.	-
startsAt	string(date-time)	true	The start date and time for the challenge, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-
endsAt	string(date-time)	true	The end date and time for the challenge, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-
registrationStartsAt	string(date-time)	true	The date and time for when consumers can start to register for the challenge, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-
registrationEndsAt	string(date-time)	true	The date and time after which consumers can no longer register for the challenge, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-
canConsumerCreateTeam	boolean	false	Indicates whether consumers belonging to a team challenge are allowed to create their own team. This value defaults to `false` if not passed.	-
timeZone	string	true	The time zone used to configure the start and end times for the challenge. This value should match a valid time zone in the Internet Assigned Numbers Authority (IANA) database.	-
maxTeamRegistrations	integer(int32)	false	The maximum number of registrations allowed in a team. By default, this value is set to null which means there is no limit and any number of consumers can register in a team.	-
catalogs	[object]	true	The IDs of one or more catalogs with which the challenge is associated.	-
» id	string	true	The ID of a challenge catalog.	-
goals	[object]	true	The IDs of one or more goals associated with the challenge.	-
» id	string	true	The ID of a goal for the challenge.	-

postTeamDefinitions

Name	Type	Required	Description	Accepted Values
teamChallengeId	string	true	The ID of a team challenge.	-
name	string	true	The name of the team.	-
description	string	false	The description of the team to help other consumers join the team.	-
imageUrl	string	false	The URL of the marketing image for the challenge.	-
createdBy	object	true	The details of who created the team.	-
» id	string	false	The unique ID of the person who created the team.	-
» kind	string	true	The kind of person who created the team. Accepted values for kind are ‘CONSUMER’ and ‘ADMIN’.	-

ConsumerEngagementPublicApi_Entities_V1_Challenges_TeamDefinition

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the team definition.	-
teamChallengeId	string	true	The ID of the team challenge that this team belongs to.	-
name	string	true	The name of the team.	-
description	string	false	The description of the team to help other consumers join the team.	-
imageURL	string	false	The URL of the team image	-
availableRegistrations	integer(int32)	false	The number of registrations available for this team. A value of null indicates that there is no limit for registrations and any number of consumers can register for this team.	-
createdBy	ConsumerEngagementPublicApi_Entities_V1_Challenges_CreatedBy	true	The details of the person who created the team.	-
createdAt	string(date-time)	true	The date and time when the team definition request was created in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-
updatedAt	string(date-time)	true	The date and time when the team definition was last updated in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-

ConsumerEngagementPublicApi_Entities_V1_Challenges_CreatedBy

Name	Type	Required	Description	Accepted Values
id	string	false	The ID of the person who created the team.	-
kind	string	true	The kind of person who created the team. Accepted values for kind are ‘CONSUMER’ and ‘ADMIN’.	-

TeamDefinitions

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

putTeamDefinitions

Name	Type	Required	Description	Accepted Values
teamChallengeId	string	true	The ID of a team challenge.	-
name	string	true	The name of the team.	-
description	string	false	The description of the team to help other consumers join the team.	-
imageUrl	string	false	The URL of the marketing image for the challenge.	-
createdBy	object	true	The details of who created the team.	-
» id	string	false	The unique ID of the person who created the team.	-
» kind	string	true	The kind of person who created the team. Accepted values for kind are ‘CONSUMER’ and ‘ADMIN’.	-

postTeamRegistrations

Name	Type	Required	Description	Accepted Values
teamChallengeId	string	true	The ID of a team challenge.	-
teamId	string	true	The ID of a team.	-
consumerId	string	true	The ID of a consumer.	-

ConsumerEngagementPublicApi_Entities_V1_Challenges_TeamRegistration

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of a team challenge registration.	-
teamChallengeId	string	true	The ID of a team challenge.	-
teamId	string	true	The ID of a team.	-
consumerId	string	true	The ID of a consumer.	-
createdAt	string(date-time)	true	The date and time when the team registration request was created in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-
updatedAt	string(date-time)	true	The date and time when the team registration was last updated in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-

TeamRegistrations

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

postChallengeGoals

Name	Type	Required	Description	Accepted Values
names	[object]	true	A list of names for the challenge goal in different locales.	-
» text	string	true	The localized name of the goal.	-
» locale	string	true	The locale for the goal name. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen, for example, `en-US`.	-
descriptions	[object]	false	A list of descriptions for the challenge goal in different locales.	-
» text	string	true	The localized description of the goal.	-
» locale	string	true	The locale for the goal description. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen, for example, `en-US`.	-
type	string	true	The type of the challenge.	STEPS, PHYSICAL_ACTIVITY, WATER, NUTRITION, FRUIT, VEGETABLES, HEALTHY_HABIT
value	number(float)	false	The total value that must be met over the specified frequency to complete the goal successfully.	-
unit	string	false	The units for the challenge.	STEPS, MINUTES, DAYS_LOGGED, OUNCES, CUPS, SERVINGS
frequency	string	false	The frequency on which the consumer must meet the goal. If frequency is not provided, it is defaulted to ONE_TIME.	ONE_TIME, DAILY, WEEKLY
isAffirmative	boolean	false	Indicates whether the goal is an affirmative type. Affirmative goals are generally used in scenarios where the completion of a goal does not have a specific value and cannot be automatically tracked by fitness devices. For example, you can create an Intermittent Fasting goal as an Affirmative goal, and users registered in the challenge can track and affirm to the goal as complete on days they met the goal. If `isAffirmative` is not provided, this value defaults defaults to `false`.	-
coding	object	false	The coding object associated with the goal type.	-
» code	string	true	The ID of the code	-
» system	string	true	The ID of the system which gives meaning to the code	-
» display	string	true	The human-readable representation of the coding	-

Goals

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

putChallengeGoals

Name	Type	Required	Description	Accepted Values
names	[object]	true	A list of names for the challenge goal in different locales.	-
» text	string	true	The localized name of the goal.	-
» locale	string	true	The locale for the goal name. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen, for example, `en-US`.	-
descriptions	[object]	false	A list of descriptions for the challenge goal in different locales.	-
» text	string	true	The localized description of the goal.	-
» locale	string	true	The locale for the goal description. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen, for example, `en-US`.	-
type	string	true	The type of the challenge.	STEPS, PHYSICAL_ACTIVITY, WATER, NUTRITION, FRUIT, VEGETABLES, HEALTHY_HABIT
value	number(float)	false	The total value that must be met over the specified frequency to complete the goal successfully.	-
unit	string	false	The units for the challenge.	STEPS, MINUTES, DAYS_LOGGED, OUNCES, CUPS, SERVINGS
frequency	string	false	The frequency on which the consumer must meet the goal. If frequency is not provided, it is defaulted to ONE_TIME.	ONE_TIME, DAILY, WEEKLY
isAffirmative	boolean	false	Indicates whether the goal is an affirmative type. Affirmative goals are generally used in scenarios where the completion of a goal does not have a specific value and cannot be automatically tracked by fitness devices. For example, you can create an Intermittent Fasting goal as an Affirmative goal, and users registered in the challenge can track and affirm to the goal as complete on days they met the goal. If `isAffirmative` is not provided, this value defaults defaults to `false`.	-
coding	object	false	The coding object associated with the goal type.	-
» code	string	true	The ID of the code	-
» system	string	true	The ID of the system which gives meaning to the code	-
» display	string	true	The human-readable representation of the coding	-

postChallengeCatalogs

Name	Type	Required	Description	Accepted Values
names	[object]	true	A list of names for the challenge catalog in different locales.	-
» text	string	true	The localized name of the catalog.	-
» locale	string	true	The locale for the catalog name. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen, for example, `en-US`.	-
descriptions	[object]	false	A list of descriptions for the challenge catalog in different locales.	-
» text	string	true	The localized description of the catalog.	-
» locale	string	true	The locale for the catalog description. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen, for example, `en-US`.	-

putChallengeCatalogs

Name	Type	Required	Description	Accepted Values
names	[object]	true	A list of names for the challenge catalog in different locales.	-
» text	string	true	The localized name of the catalog.	-
» locale	string	true	The locale for the catalog name. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen, for example, `en-US`.	-
descriptions	[object]	false	A list of descriptions for the challenge catalog in different locales.	-
» text	string	true	The localized description of the catalog.	-
» locale	string	true	The locale for the catalog description. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen, for example, `en-US`.	-

postChallengeRegistrations

Name	Type	Required	Description	Accepted Values
challengeId	string	true	The ID of a challenge.	-
consumerId	string	true	The ID of a consumer.	-
status	string	false	Tracks whether the consumer is currently registered or unregistered for a challenge.	ACTIVE, INACTIVE

ConsumerEngagementPublicApi_Entities_V1_Challenges_ChallengeRegistration

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of a challenge registration.	-
challengeId	string	true	The ID of a challenge.	-
consumerId	string	true	The ID of a consumer.	-
status	string	true	Indicates whether the consumer is currently registered or unregistered for a challenge.	ACTIVE, INACTIVE
createdAt	string(date-time)	true	The date and time when the challenge registration request was created in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-
updatedAt	string(date-time)	true	The date and time when the challenge registration was last updated in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-

ChallengeRegistrations

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

postChallengeOutcomes

Name	Type	Required	Description	Accepted Values
challengeId	string	true	The ID of a challenge.	-
consumerId	string	true	The ID of a consumer.	-
total	integer(int32)	true	The total amount of activity done by consumer in the challenge. For example, 100,000 steps or 300 minutes of physical activity.	-

ConsumerEngagementPublicApi_Entities_V1_Challenges_ChallengeOutcome

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of a challenge outcome.	-
challengeId	string	true	The ID of a challenge.	-
consumerId	string	true	The ID of a consumer.	-
total	integer(int32)	true	The total amount of activity completed by a consumer during the challenge, for example, 100,000 steps or 300 minutes of physical activity.	-
rank	integer(int32)	true	The rank of a consumer among all the participants of the challenge, calculated based on the total value. The rank can be null if outcomes are not yet processed.	-
status	string	true	The completion status of a consumer for the challenge. The status is based on whether the challenge goal is met. Possible status values are COMPLETE or INCOMPLETE.	-
unit	string	true	The unit for the total amount of activity completed by the consumer in the challenge. Possible values are STEPS, MINUTES, DAYS_LOGGED, or OUNCES.	STEPS, MINUTES, DAYS_LOGGED, OUNCES
updatedAt	string(date-time)	true	The date and time when the challenge outcome was last updated, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. This date and time is not based on current tracker data.	-

ChallengeOutcomes

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

putChallengeOutcomes

Name	Type	Required	Description	Accepted Values
challengeId	string	true	The ID of a challenge.	-
consumerId	string	true	The ID of a consumer.	-
total	integer(int32)	true	The total amount of activity done by consumer in the challenge. For example, 100,000 steps or 300 minutes of physical activity.	-

postTeamOutcomes

Name	Type	Required	Description	Accepted Values
teamChallengeId	string	true	The ID of a team challenge.	-
teamId	string	true	The ID of a team.	-
total	integer(int32)	true	The total amount of activity completed by consumer during the team challenge, for example, 100,000 steps or 300 minutes of physical activity.	-
consumerId	string	true	The ID of a consumer.	-
status	string	false	The completion status of a consumer for the challenge. The status is based on whether the challenge goal is met. Possible status values are COMPLETE or INCOMPLETE.	-
unit	string	false	The unit for the total amount of activity completed by the consumer during the team challenge. Possible status values are STEPS, MINUTES, DAYS_LOGGED, or OUNCES.	-

ConsumerEngagementPublicApi_Entities_V1_Challenges_TeamOutcomeCreateResponse

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of a team outcome.	-
teamChallengeId	string	true	The ID of a team challenge.	-
teamId	string	true	The ID of a team.	-
consumerId	string	true	The ID of a consumer.	-
total	integer(int32)	true	The total amount of activity completed by a consumer during the team challenge, for example, 100,000 steps or 300 minutes of physical activity.	-

TeamOutcomes

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

ConsumerEngagementPublicApi_Entities_V1_Challenges_TeamOutcome

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of a team outcome.	-
teamChallengeId	string	true	The ID of a team challenge.	-
teamId	string	true	The ID of a team.	-
consumerId	string	true	The ID of a consumer.	-
total	integer(int32)	true	The total amount of activity completed by a consumer during the team challenge, for example, 100,000 steps or 300 minutes of physical activity.	-
rank	integer(int32)	true	The rank of a consumer among all the participants of a team for a challenge. The rank can be null if outcomes are not yet processed.	-
status	string	true	The completion status of a consumer for the challenge. The status is based on whether the challenge goal is met. Possible status values are COMPLETE or INCOMPLETE.	-
unit	string	true	The unit for the total amount of activity completed by the consumer during the team challenge. Possible status values are STEPS, MINUTES, DAYS_LOGGED, or OUNCES.	STEPS, MINUTES, DAYS_LOGGED, OUNCES
updatedAt	string(date-time)	true	The date and time when the team outcome was last updated, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. This date and time is not based on current tracker data.	-

putTeamOutcomes

Name	Type	Required	Description	Accepted Values
teamChallengeId	string	true	The ID of a team challenge.	-
teamId	string	true	The ID of a team.	-
total	integer(int32)	true	The total amount of activity completed by consumer during the team challenge, for example, 100,000 steps or 300 minutes of physical activity.	-
consumerId	string	true	The ID of a consumer.	-
status	string	false	The completion status of a consumer for the challenge. The status is based on whether the challenge goal is met. Possible status values are COMPLETE or INCOMPLETE.	-
unit	string	false	The unit for the total amount of activity completed by the consumer during the team challenge. Possible status values are STEPS, MINUTES, DAYS_LOGGED, or OUNCES.	-

postTeamChallengeOutcomes

Name	Type	Required	Description	Accepted Values
teamChallengeId	string	true	The ID of a team challenge.	-
teamId	string	true	The ID of a team.	-
total	integer(int32)	true	The total amount of activity completed by a team during the challenge, for example, 100,000 steps or 300 minutes of physical activity.	-
status	string	false	Filters the team challenge outcomes by the completion status of a team for the challenge. The status is based on whether the team met the challenge goal. Possible status values are COMPLETE or INCOMPLETE.	-
unit	string	false	The unit for the total amount of activity completed by the team during the challenge. Possible values are STEPS, MINUTES, DAYS_LOGGED, or OUNCES.	-
average	number(float)	false	The average value calculated based on the total and the number of consumers on a team during a team challenge.	-

ConsumerEngagementPublicApi_Entities_V1_Challenges_TeamChallengeOutcomeCreateResponse

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of a team challenge outcome.	-
teamChallengeId	string	true	The ID of a team challenge.	-
teamId	string	true	The ID of a team.	-
total	integer(int32)	true	The total amount of activity completed by a team during the challenge, for example, 100,000 steps or 300 minutes of physical activity.	-

TeamChallengeOutcomes

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

ConsumerEngagementPublicApi_Entities_V1_Challenges_TeamChallengeOutcome

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of a team challenge outcome.	-
teamChallengeId	string	true	The ID of a team challenge.	-
teamId	string	true	The ID of a team.	-
total	integer(int32)	true	The total amount of activity completed by a team during the challenge, for example, 100,000 steps or 300 minutes of physical activity.	-
average	number(float)	true	The average value calculated based on the total and the number of consumers on a team during a team challenge.	-
rank	integer(int32)	true	The rank of a team among all the teams in a team challenge, calculated based on the total value. The rank can be null if outcomes are not yet processed.	-
status	string	true	The completion status of a team for the challenge. The status is based on whether the team met the challenge goal. Possible status values are COMPLETE or INCOMPLETE.	-
unit	string	true	The unit for the total amount of activity completed by the team during the challenge. Possible values are STEPS, MINUTES, DAYS_LOGGED, or OUNCES.	STEPS, MINUTES, DAYS_LOGGED, OUNCES
updatedAt	string(date-time)	true	The date and time when the team challenge outcome was last updated, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. This date and time is not based on current tracker data.	-

putTeamChallengeOutcomes

Name	Type	Required	Description	Accepted Values
teamChallengeId	string	true	The ID of a team challenge.	-
teamId	string	true	The ID of a team.	-
total	integer(int32)	true	The total amount of activity completed by a team during the challenge, for example, 100,000 steps or 300 minutes of physical activity.	-
status	string	false	Filters the team challenge outcomes by the completion status of a team for the challenge. The status is based on whether the team met the challenge goal. Possible status values are COMPLETE or INCOMPLETE.	-
unit	string	false	The unit for the total amount of activity completed by the team during the challenge. Possible values are STEPS, MINUTES, DAYS_LOGGED, or OUNCES.	-
average	number(float)	false	The average value calculated based on the total and the number of consumers on a team during a team challenge.	-

postGoalObservations

Name	Type	Required	Description	Accepted Values
consumer	object	true	No description	-
» id	string	true	The ID of the consumer.	-
goal	object	true	No description	-
» id	string	true	The ID of the goal.	-
value	number(float)	false	The value of the observation.	-
unit	string	false	The unit of the observation.	CUPS, SERVINGS
performedAt	string(date-time)	true	The date and time when the consumer performed the goal displayed in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-
timeZone	string	true	The time zone where the consumer performed the goal. This value must match a valid time zone in the IANA database.	-

ConsumerEngagementPublicApi_Entities_V1_Challenges_GoalObservation

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the goal observation.	-
consumer	ConsumerEngagementPublicApi_Entities_V1_Challenges_Consumer	true	The consumer to whom the observation is tied.	-
goal	ConsumerEngagementPublicApi_Entities_V1_Challenges_GoalRelatedResource	true	The challenge goal to which the observation is tied.	-
value	number(float)	false	The value of the observation.	-
unit	string	false	The unit of the observation.	-
performedAt	string(date-time)	true	The date and time when the consumer performed the observation displayed in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-
timeZone	string	true	The time zone where the consumer performed the observation. This value matches a valid time zone in the IANA database.	-
createdAt	string(date-time)	true	The date and time for when the the observation was created, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-
updatedAt	string(date-time)	true	The date and time for when the the observation was last updated, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-

ConsumerEngagementPublicApi_Entities_V1_Challenges_Consumer

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

ConsumerEngagementPublicApi_Entities_V1_Challenges_GoalRelatedResource

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

GoalObservations

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

putGoalObservations

Name	Type	Required	Description	Accepted Values
goal	object	true	No description	-
» id	string	true	The ID of the goal.	-
value	number(float)	false	The value of the observation.	-
unit	string	false	The unit of the observation.	CUPS, SERVINGS
performedAt	string(date-time)	false	The date and time when the consumer performed the goal displayed in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-
timeZone	string	false	The time zone where the consumer performed the goal. This value must match a valid time zone in the IANA database.	-

AggregatedGoalObservations

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

ConsumerEngagementPublicApi_Entities_V1_Challenges_AggregatedGoalObservation

Name	Type	Required	Description	Accepted Values
consumer	ConsumerEngagementPublicApi_Entities_V1_Challenges_Consumer	true	The consumer goal to which the aggregated goal observations are tied.	-
goal	ConsumerEngagementPublicApi_Entities_V1_Challenges_GoalRelatedResource	true	The challenge goal to which the observation is tied.	-
value	number(float)	false	The value of the observation.	-
unit	string	false	The unit of the observation.	-
frequency	string	true	The frequency on which values are aggregated. If frequency is not passed, observations are aggregated DAILY.	DAILY, WEEKLY
frequencyStartsAt	string(date)	true	The starting date for which observations are aggregated.	-
timeZone	string	true	The time zone used to configure the starting date and time of the frequency. This value matches a valid time zone in the IANA database.	-

QuestionnaireDefinitions

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

ConsumerEngagementPublicApi_Entities_V1_Questionnaires_QuestionnaireDefinition

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the Questionnaire definition.	-
questionnaireId	string	true	The ID of the questionnaire. This ID does not identify an actual resource. It represents the concept of a Questionnaire.	-
name	string	true	The name of the Questionnaire. The value of this attribute is unique for every questionnaireID value.	-
type	string	true	Describes the type of the questionnaire. At present, the only allowable values are `PHA` and `CAMPAIGN`.	-
locale	string	true	The locale of the Questionnaire.	-
description	string	false	The human-readable description of the Questionnaire.	-
code	Code	false	The code from a single, specified (not fixed) code system.	-

Code

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

postQuestionnaireDefinitions

Name	Type	Required	Description	Accepted Values
name	string	true	The name of the Questionnaire. The value of this attribute is unique for every questionnaireID value.	-
questionnaireId	string	true	The ID of the questionnaire. This ID does not identify an actual resource. It represents the concept of a Questionnaire.	-
type	string	true	Describes the type of the questionnaire. At present, the only allowable values are `PHA` and `CAMPAIGN`.	PHA,, CAMPAIGN
locale	string	true	The locale of the Questionnaire.	-
description	string	false	The human-readable description of the Questionnaire.	-
code	object	false	A code represents a concept for the Questionnaire definition from a single, specified code system.	-
» code	string	true	The unique ID of the code.	-
» system	string	true	The unique ID of the coding system that gives meaning to the code.	-
» display	string	false	A human-readable representation of the code.	-

putQuestionnaireDefinitions

Name	Type	Required	Description	Accepted Values
name	string	true	The name of the Questionnaire. The value of this attribute is unique for every questionnaireID value.	-
questionnaireId	string	true	The ID of the questionnaire. This ID does not identify an actual resource. It represents the concept of a Questionnaire.	-
type	string	true	Describes the type of the questionnaire. At present, the only allowable values are `PHA` and `CAMPAIGN`.	PHA,, CAMPAIGN
locale	string	true	The locale of the Questionnaire.	-
description	string	false	The human-readable description of the Questionnaire.	-
code	object	false	A code represents a concept for the Questionnaire definition from a single, specified code system.	-
» code	string	true	The unique ID of the code.	-
» system	string	true	The unique ID of the coding system that gives meaning to the code.	-
» display	string	false	A human-readable representation of the code.	-

QuestionnaireSections

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

ConsumerEngagementPublicApi_Entities_V1_Questionnaires_QuestionnaireSection

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the Questionnaire section.	-
name	string	true	The name of the Questionnaire section.	-
description	string	false	The human-readable description of the Questionnaire section.	-
position	integer(int32)	true	A position of a section indicates that the section must be at the given position in the sequence of sections in the Questionnaire. The position must be unique within the Questionnaire.	-
code	ConsumerEngagementPublicApi_Entities_V1_Questionnaires_Code	false	The code of the Questionnaire section from a single, specified (not fixed) code system.	-

ConsumerEngagementPublicApi_Entities_V1_Questionnaires_Code

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

postQuestionnaireDefinitionsQuestionnairedefinitionidSections

Name	Type	Required	Description	Accepted Values
name	string	true	The name of the Questionnaire section.	-
description	string	false	The human-readable description of the Questionnaire section.	-
position	integer(int32)	true	A position of a section indicates that the section must be at the given position in the sequence of sections in the Questionnaire. The position must be unique within the Questionnaire.	-
code	object	false	A code represents a concept for the Questionnaire section from a single, specified code system.	-
» code	string	true	The unique ID of the code.	-
» system	string	true	The unique ID of the coding system that gives meaning to the code.	-
» display	string	false	A human-readable representation of the code.	-

putQuestionnaireDefinitionsQuestionnairedefinitionidSections

Name	Type	Required	Description	Accepted Values
name	string	true	The name of the Questionnaire section.	-
description	string	false	The human-readable description of the Questionnaire section.	-
position	integer(int32)	true	A position of a section indicates that the section must be at the given position in the sequence of sections in the Questionnaire. The position must be unique within the Questionnaire.	-
code	object	false	A code represents a concept for the Questionnaire section from a single, specified code system.	-
» code	string	true	The unique ID of the code.	-
» system	string	true	The unique ID of the coding system that gives meaning to the code.	-
» display	string	false	A human-readable representation of the code.	-

QuestionnaireSubsections

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

ConsumerEngagementPublicApi_Entities_V1_Questionnaires_QuestionnaireSubsection

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the questionnaire subsection.	-
name	string	true	The name of the Questionnaire subsection.	-
description	string	false	The human-readable description of the Questionnaire subsection.	-
position	integer(int32)	true	A position of a section indicates that the subsection must be at the given position in the sequence of subsections in the Questionnaire section. The position must be unique within the section in which the subsection is grouped.	-
code	ConsumerEngagementPublicApi_Entities_V1_Questionnaires_Code	false	The code of the Questionnaire subsection from a single, specified (not fixed) code system.	-
section	ConsumerEngagementPublicApi_Entities_V1_Questionnaires_Reference_QuestionnaireSectionReference	true	A reference to the Questionnaire section.	-

ConsumerEngagementPublicApi_Entities_V1_Questionnaires_Reference_QuestionnaireSectionReference

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

postQuestionnaireDefinitionsQuestionnairedefinitionidSubsections

Name	Type	Required	Description	Accepted Values
name	string	true	The name of the Questionnaire subsection.	-
description	string	false	The human-readable description of the Questionnaire subsection.	-
position	integer(int32)	true	A position of a section indicates that the subsection must be at the given position in the sequence of subsections in the Questionnaire section. The position must be unique within the section in which the subsection is grouped.	-
code	object	false	The code of the Questionnaire subsection from a single, specified (not fixed) code system.	-
» code	string	true	The unique ID of the code.	-
» system	string	true	The unique ID of the coding system that gives meaning to the code.	-
» display	string	false	A human-readable representation of the code.	-
section	object	true	A reference to the Questionnaire section.	-
» id	string	true	The ID of the Questionnaire section.	-

putQuestionnaireDefinitionsQuestionnairedefinitionidSubsections

Name	Type	Required	Description	Accepted Values
name	string	true	The name of the Questionnaire subsection.	-
description	string	false	The human-readable description of the Questionnaire subsection.	-
position	integer(int32)	true	A position of a section indicates that the subsection must be at the given position in the sequence of subsections in the Questionnaire section. The position must be unique within the section in which the subsection is grouped.	-
code	object	false	The code of the Questionnaire subsection from a single, specified (not fixed) code system.	-
» code	string	true	The unique ID of the code.	-
» system	string	true	The unique ID of the coding system that gives meaning to the code.	-
» display	string	false	A human-readable representation of the code.	-
section	object	true	A reference to the Questionnaire section.	-
» id	string	true	The ID of the Questionnaire section.	-

QuestionnaireQuestions

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

ConsumerEngagementPublicApi_Entities_V1_Questionnaires_QuestionnaireQuestion

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the question.	-
text	string	true	The human-readable text of the question.	-
type	string	true	The type of the question in the questionnaire. The following types are available: - `TEXT` A question with a long, potentially multiparagraph free-text answer. - `STRING` A question with a short free-text answer. The maximum length is 255 characters. - `DATE_TIME` A question with a date and time answer. - `CHOICE` A question with a choice from a list of options as an answer. - `DATE` A question with a date answer. - `OPEN_CHOICE` A question with a choice from a list of options (as with the `CHOICE` type) or a free-text answer. - `RANGE` A question with an answer that is a numeric value between a high and a low value.	TEXT, STRING, DATE_TIME, CHOICE, RANGE, DATE, OPEN_CHOICE
description	string	false	A free-text description of the questionnaire question that provides instructions or additional context for a user to answer the question.	-
acceptsMultipleAnswers	boolean	true	Indicates whether the question can have more than one answer.	-
required	boolean	true	Indicates whether the question must be answered in a completed response.	-
position	integer(int32)	true	Indicates that the question must be at the given position in the sequence of questions in the section or subsection. The position must be unique within the section or the subsection in which the question is grouped.	-
section	ConsumerEngagementPublicApi_Entities_V1_Questionnaires_Reference_QuestionnaireSectionReference	false	A reference to the questionnaire section. A question should be in either a section or a subsection.	-
subsection	ConsumerEngagementPublicApi_Entities_V1_Questionnaires_Reference_QuestionnaireSubsectionReference	false	A reference to the questionnaire subsection. A question should be in either a section or a subsection.	-
code	ConsumerEngagementPublicApi_Entities_V1_Questionnaires_Code	false	The code for the questionnaire question from a single, specified (not fixed) code system.	-
options	[ConsumerEngagementPublicApi_Entities_V1_Questionnaires_Option]	false	The possible answers to the questionnaire question.	-

ConsumerEngagementPublicApi_Entities_V1_Questionnaires_Reference_QuestionnaireSubsectionReference

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

ConsumerEngagementPublicApi_Entities_V1_Questionnaires_Option

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the questionnaire option.	-
choice	ConsumerEngagementPublicApi_Entities_V1_Questionnaires_Choice	false	A permitted choice that can be chosen as an answer to the question.	-
range	ConsumerEngagementPublicApi_Entities_V1_Questionnaires_Range	false	The permitted range in which the answer can be chosen for the question.	-

ConsumerEngagementPublicApi_Entities_V1_Questionnaires_Choice

Name	Type	Required	Description	Accepted Values
points	integer(int32)	false	The total points earned by selecting this choice as an answer to the question.	-
text	string	true	A free-text description of the choice.	-

ConsumerEngagementPublicApi_Entities_V1_Questionnaires_Range

Name	Type	Required	Description	Accepted Values
low	number(float)	true	The lowest possible value for the answer. The boundary is inclusive.	-
high	number(float)	true	The highest possible value for the answer. The boundary is inclusive.	-
text	string	true	A human-readable description of the range.	-

postQuestionnaireDefinitionsQuestionnairedefinitionidQuestions

Name	Type	Required	Description	Accepted Values
text	string	true	The human-readable text of the question.	-
type	string	true	The type of the question in the questionnaire. The following types are available: - `TEXT` A question with a long, potentially multiparagraph free-text answer. - `STRING` A question with a short free-text answer. The maximum length is 255 characters. - `DATE_TIME` A question with a date and time answer. - `CHOICE` A question with a choice from a list of options as an answer. - `DATE` A question with a date answer. - `OPEN_CHOICE` A question with a choice from a list of options (as with the `CHOICE` type) or a free-text answer. - `RANGE` A question with an answer that is a numeric value between a high and a low value.	TEXT, STRING, DATE_TIME, CHOICE, RANGE, DATE, OPEN_CHOICE
description	string	false	A free-text description of the questionnaire question that provides instructions or additional context for a user to answer the question.	-
acceptsMultipleAnswers	boolean	false	Indicates whether the question can have more than one answer.	-
required	boolean	false	Indicates whether the question must be answered in a completed response.	-
position	integer(int32)	true	Indicates that the question must be at the given position in the sequence of questions in the section or subsection. The position must be unique within the section or the subsection in which the question is grouped.	-
section	object	false	A reference to the questionnaire section. A question should be in either a section or a subsection.	-
» id	string	true	The ID of the Questionnaire section.	-
subsection	object	false	A reference to the questionnaire subsection. A question should be in either a section or a subsection.	-
» id	string	true	The ID of the questionnaire subsection.	-
code	object	false	The code for the questionnaire question from a single, specified (not fixed) code system.	-
» code	string	true	The unique ID of the code.	-
» system	string	true	The unique ID of the coding system that gives meaning to the code.	-
» display	string	false	A human-readable representation of the code.	-
options	[object]	false	The possible answers to the questionnaire question.	-
» choice	object	false	A permitted choice that can be chosen as an answer to the question.	-
»» points	integer(int32)	false	The total points earned by selecting this choice as an answer to the question.	-
»» text	string	true	A free-text description of the choice.	-
» range	object	false	The permitted range in which the answer can be chosen for the question.	-
»» low	number(float)	true	The lowest possible value for the answer. The boundary is inclusive.	-
»» high	number(float)	true	The highest possible value for the answer. The boundary is inclusive.	-
»» text	string	true	A human-readable description of the range.	-

putQuestionnaireDefinitionsQuestionnairedefinitionidQuestions

Name	Type	Required	Description	Accepted Values
text	string	true	The human-readable text of the question.	-
type	string	true	The type of the question in the questionnaire. The following types are available: - `TEXT` A question with a long, potentially multiparagraph free-text answer. - `STRING` A question with a short free-text answer. The maximum length is 255 characters. - `DATE_TIME` A question with a date and time answer. - `CHOICE` A question with a choice from a list of options as an answer. - `DATE` A question with a date answer. - `OPEN_CHOICE` A question with a choice from a list of options (as with the `CHOICE` type) or a free-text answer. - `RANGE` A question with an answer that is a numeric value between a high and a low value.	TEXT, STRING, DATE_TIME, CHOICE, RANGE, DATE, OPEN_CHOICE
description	string	false	A free-text description of the questionnaire question that provides instructions or additional context for a user to answer the question.	-
acceptsMultipleAnswers	boolean	false	Indicates whether the question can have more than one answer.	-
required	boolean	false	Indicates whether the question must be answered in a completed response.	-
position	integer(int32)	true	Indicates that the question must be at the given position in the sequence of questions in the section or subsection. The position must be unique within the section or the subsection in which the question is grouped.	-
section	object	false	A reference to the questionnaire section. A question should be in either a section or a subsection.	-
» id	string	true	The ID of the Questionnaire section.	-
subsection	object	false	A reference to the questionnaire subsection. A question should be in either a section or a subsection.	-
» id	string	true	The ID of the questionnaire subsection.	-
code	object	false	The code for the questionnaire question from a single, specified (not fixed) code system.	-
» code	string	true	The unique ID of the code.	-
» system	string	true	The unique ID of the coding system that gives meaning to the code.	-
» display	string	false	A human-readable representation of the code.	-
options	[object]	false	The possible answers to the questionnaire question.	-
» choice	object	false	A permitted choice that can be chosen as an answer to the question.	-
»» points	integer(int32)	false	The total points earned by selecting this choice as an answer to the question.	-
»» text	string	true	A free-text description of the choice.	-
» range	object	false	The permitted range in which the answer can be chosen for the question.	-
»» low	number(float)	true	The lowest possible value for the answer. The boundary is inclusive.	-
»» high	number(float)	true	The highest possible value for the answer. The boundary is inclusive.	-
»» text	string	true	A human-readable description of the range.	-

postQuestionnaireDefinitionsQuestionnairedefinitionidClone

Name	Type	Required	Description	Accepted Values
sections	[object]	true	A list of Questionnaire section IDs to clone. If a section ID is missing from this list it will not be cloned to the new Questionnaire.	-
» id	string	true	The ID of the Questionnaire section to clone.	-
type	string	true	The type of existing Questionnaire being cloned.STANDARD: The Questionnaire being cloned is one of the standard Questionnaires provided by Health Data Intelligence. CUSTOM: The Questionnaire being cloned is a Questionnaire that already exists under the current tenant.,	STANDARD, CUSTOM
questionnaireId	string	false	The ID of the Questionnaire. It will override the questionnaireId field of the cloned questionnaireDefinition if provided. If it is not provided, then the cloned questionnaireId will be copied from the existing questionnaireDefinition.	-
name	string	false	The name of the Questionnaire. It will override the name field of the cloned questionnaireDefinition if provided. If it is not provided, then the cloned name will be copied from the existing questionnaireDefinition.	-

ConsumerEngagementPublicApi_Entities_V1_Questionnaires_QuestionnaireClone

Name	Type	Required	Description	Accepted Values
clonedQuestionnaireDefinition	ConsumerEngagementPublicApi_Entities_V1_Questionnaires_ClonedQuestionnaireDefinitionReference	true	The Cloned Questionnaire Definition Reference.	-

ConsumerEngagementPublicApi_Entities_V1_Questionnaires_ClonedQuestionnaireDefinitionReference

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

QuestionnaireResponseDefinitions

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

ConsumerEngagementPublicApi_Entities_V1_Questionnaires_QuestionnaireResponseDefinition

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the questionniare response definition.	-
authoredAt	string	true	The date and time when the questionniare response was submitted or updated. The date and time must be in ISO 8601 YYYY-MM-DDThh:mm:ssTZD format, for example, 1997-07-16T19:20:30+01:00.	-
publishedQuestionnaire	ConsumerEngagementPublicApi_Entities_V1_Questionnaires_Reference_QuestionnaireDefinitionReference	true	A reference to the Questionnaire definition.	-
consumer	ConsumerEngagementPublicApi_Entities_V1_Questionnaires_Reference_ConsumerReference	true	A reference to the Health Data Intelligence consumer.	-
completedQuestionnaireResponses	[ConsumerEngagementPublicApi_Entities_V1_Questionnaires_Reference_CompletedQuestionnaireResponseReference]	false	A reference to the completed Questionnaire response.	-

ConsumerEngagementPublicApi_Entities_V1_Questionnaires_Reference_QuestionnaireDefinitionReference

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the Questionnaire definition.	-
name	string	true	The name of the Questionnaire. The value of this attribute is unique for every questionnaireId value.	-

ConsumerEngagementPublicApi_Entities_V1_Questionnaires_Reference_ConsumerReference

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

ConsumerEngagementPublicApi_Entities_V1_Questionnaires_Reference_CompletedQuestionnaireResponseReference

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the completed questionnaire response.	-
authoredAt	string	true	The date and time when the questionnaire response was completed. The date and time must be in ISO 8601 YYYY-MM-DDThh:mm:ssTZD format, for example, 1997-07-16T19:20:30+01:00.	-

postQuestionnaireResponseDefinitions

Name	Type	Required	Description	Accepted Values
authoredAt	string	true	The date and time when the questionniare response was submitted or updated. The date and time must be in ISO 8601 YYYY-MM-DDThh:mm:ssTZD format, for example, 1997-07-16T19:20:30+01:00.	-
consumer	object	true	A reference to the Health Data Intelligence consumer.	-
» id	string	true	The ID of the Health Data Intelligence consumer.	-
publishedQuestionnaire	object	true	A reference to the Questionnaire definition.	-
» id	string	true	The ID of the published Questionnaire.	-

putQuestionnaireResponseDefinitions

Name	Type	Required	Description	Accepted Values
authoredAt	string	true	The date and time when the questionniare response was submitted or updated. The date and time must be in ISO 8601 YYYY-MM-DDThh:mm:ssTZD format, for example, 1997-07-16T19:20:30+01:00.	-
consumer	object	true	A reference to the Health Data Intelligence consumer.	-
» id	string	true	The ID of the Health Data Intelligence consumer.	-
publishedQuestionnaire	object	true	A reference to the Questionnaire definition.	-
» id	string	true	The ID of the published Questionnaire.	-

QuestionnaireResponseSections

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

ConsumerEngagementPublicApi_Entities_V1_Questionnaires_QuestionnaireResponseSection

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the Questionnaire response section.	-
section	ConsumerEngagementPublicApi_Entities_V1_Questionnaires_Reference_QuestionnaireSectionReference	true	A reference to the Questionnaire section.	-
status	string	true	The current state of the Questionnaire response section. Currently, the following statuses are supported: - `NOT_STARTED` Indicates that the Health Data Intelligence consumer has not started answering the Questionnaire section. - `IN_PROGRESS` Indicates that the Health Data Intelligence consumer is currently answering the Questionnaire Section. - `COMPLETED` Indicates that the Health Data Intelligence consumer has finished answering the Questionnaire section.	NOT_STARTED, IN_PROGRESS, COMPLETED, ENTERED_IN_ERROR
answers	[ConsumerEngagementPublicApi_Entities_V1_Questionnaires_QuestionnaireAnswer]	false	The answers given by the Health Data Intelligence consumer to questions in the Questionnaire section.	-

ConsumerEngagementPublicApi_Entities_V1_Questionnaires_QuestionnaireAnswer

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the Questionnaire answer.	-
question	ConsumerEngagementPublicApi_Entities_V1_Questionnaires_Reference_QuestionnaireQuestionReference	true	A reference to the Questionnaire question that is answered.	-
values	[ConsumerEngagementPublicApi_Entities_V1_Questionnaires_AnswerValue]	true	The values of the answer.	-

ConsumerEngagementPublicApi_Entities_V1_Questionnaires_Reference_QuestionnaireQuestionReference

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

ConsumerEngagementPublicApi_Entities_V1_Questionnaires_AnswerValue

Name	Type	Required	Description	Accepted Values
option	ConsumerEngagementPublicApi_Entities_V1_Questionnaires_Reference_OptionReference	false	A reference to the option that is chosen as the answer.	-
value	string	false	A value that represents the answer to the question. The following values are accepted for different types of questions: - `TEXT` A long, potentially multiparagraph free-text answer. The maximum length is 65,535 characters. - `STRING` A short free-text answer. The maximum length is 255 characters. - `DATE_TIME` A date and time answer in ISO 8601 YYYY-MM-DDThh:mm:ssTZD format. - `CHOICE` No answer value can be specified for this type of question. - `DATE` A date answer in ISO 8601 YYYY-MM-DD format. - `OPEN_CHOICE` A long, potentially multiparagraph free-text answer that is paired with options. The maximum length is 65,535 characters. - `RANGE` A number between a high and a low value specified by the question with a precision that does not exceed 10 and a scale that does not exceed 3.	-

ConsumerEngagementPublicApi_Entities_V1_Questionnaires_Reference_OptionReference

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

postQuestionnaireResponseDefinitionsQuestionnaireresponsedefinitionidResponseSections

Name	Type	Required	Description	Accepted Values
status	string	false	The current state of the Questionnaire response section. Currently, the following statuses are supported: - `NOT_STARTED` Indicates that the Health Data Intelligence consumer has not started answering the Questionnaire section. - `IN_PROGRESS` Indicates that the Health Data Intelligence consumer is currently answering the Questionnaire Section. - `COMPLETED` Indicates that the Health Data Intelligence consumer has finished answering the Questionnaire section.	NOT_STARTED, IN_PROGRESS, COMPLETED, ENTERED_IN_ERROR
section	object	true	A reference to the Questionnaire section.	-
» id	string	true	The ID of the Questionnaire section.	-
answers	[object]	false	The answers given by the Health Data Intelligence consumer to questions in the Questionnaire section.	-
» question	object	true	A reference to the Questionnaire question that is answered.	-
»» id	string	true	The ID of the question.	-
» values	[object]	true	The values of the answer.	-
»» option	object	false	A reference to the option that is chosen as the answer.	-
»»» id	string	true	The ID of the questionnaire option.	-
»» value	string	false	A value that represents the answer to the question. The following values are accepted for different types of questions: - `TEXT` A long, potentially multiparagraph free-text answer. The maximum length is 65,535 characters. - `STRING` A short free-text answer. The maximum length is 255 characters. - `DATE_TIME` A date and time answer in ISO 8601 YYYY-MM-DDThh:mm:ssTZD format. - `CHOICE` No answer value can be specified for this type of question. - `DATE` A date answer in ISO 8601 YYYY-MM-DD format. - `OPEN_CHOICE` A long, potentially multiparagraph free-text answer that is paired with options. The maximum length is 65,535 characters. - `RANGE` A number between a high and a low value specified by the question with a precision that does not exceed 10 and a scale that does not exceed 3.	-

ConsumerEngagementPublicApi_Entities_V1_Questionnaires_QuestionnaireResponseSectionGroup

Name	Type	Required	Description	Accepted Values
questionnaireResponseSections	[ConsumerEngagementPublicApi_Entities_V1_Questionnaires_QuestionnaireResponseSection]	true	A grouping of Questionnaire response sections.	-

putQuestionnaireResponseDefinitionsQuestionnaireresponsedefinitionidResponseSections

Name	Type	Required	Description	Accepted Values
status	string	false	The current state of the Questionnaire response section. Currently, the following statuses are supported: - `NOT_STARTED` Indicates that the Health Data Intelligence consumer has not started answering the Questionnaire section. - `IN_PROGRESS` Indicates that the Health Data Intelligence consumer is currently answering the Questionnaire Section. - `COMPLETED` Indicates that the Health Data Intelligence consumer has finished answering the Questionnaire section.	NOT_STARTED, IN_PROGRESS, COMPLETED, ENTERED_IN_ERROR
section	object	true	A reference to the Questionnaire section.	-
» id	string	true	The ID of the Questionnaire section.	-
answers	[object]	false	The answers given by the Health Data Intelligence consumer to questions in the Questionnaire section.	-
» question	object	true	A reference to the Questionnaire question that is answered.	-
»» id	string	true	The ID of the question.	-
» values	[object]	true	The values of the answer.	-
»» option	object	false	A reference to the option that is chosen as the answer.	-
»»» id	string	true	The ID of the questionnaire option.	-
»» value	string	false	A value that represents the answer to the question. The following values are accepted for different types of questions: - `TEXT` A long, potentially multiparagraph free-text answer. The maximum length is 65,535 characters. - `STRING` A short free-text answer. The maximum length is 255 characters. - `DATE_TIME` A date and time answer in ISO 8601 YYYY-MM-DDThh:mm:ssTZD format. - `CHOICE` No answer value can be specified for this type of question. - `DATE` A date answer in ISO 8601 YYYY-MM-DD format. - `OPEN_CHOICE` A long, potentially multiparagraph free-text answer that is paired with options. The maximum length is 65,535 characters. - `RANGE` A number between a high and a low value specified by the question with a precision that does not exceed 10 and a scale that does not exceed 3.	-

QuestionnaireResponseSubsections

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

ConsumerEngagementPublicApi_Entities_V1_Questionnaires_QuestionnaireResponseSubsection

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the Questionnaire response subsection.	-
status	string	true	The current state of the Questionnaire response subsection. Currently, the following statuses are supported: - `NOT_STARTED` Indicates that the Health Data Intelligence consumer has not started answering the Questionnaire subsection. - `IN_PROGRESS` Indicates that the Health Data Intelligence consumer is currently answering the Questionnaire subsection. - `COMPLETED` Indicates that the Health Data Intelligence consumer has finished answering the Questionnaire subsection.	NOT_STARTED, IN_PROGRESS, COMPLETED, ENTERED_IN_ERROR
subsection	ConsumerEngagementPublicApi_Entities_V1_Questionnaires_Reference_QuestionnaireSubsectionReference	true	A reference to the Questionnaire subsection.	-
answers	[ConsumerEngagementPublicApi_Entities_V1_Questionnaires_QuestionnaireAnswer]	false	The answers given by the Health Data Intelligence consumer to questions in the Questionnaire subsection.	-

postQuestionnaireResponseDefinitionsQuestionnaireresponsedefinitionidResponseSubsections

Name	Type	Required	Description	Accepted Values
subsection	object	true	A reference to the Questionnaire subsection.	-
» id	string	true	The ID of the questionnaire subsection.	-
status	string	false	The current state of the Questionnaire response subsection. Currently, the following statuses are supported: - `NOT_STARTED` Indicates that the Health Data Intelligence consumer has not started answering the Questionnaire subsection. - `IN_PROGRESS` Indicates that the Health Data Intelligence consumer is currently answering the Questionnaire subsection. - `COMPLETED` Indicates that the Health Data Intelligence consumer has finished answering the Questionnaire subsection.	NOT_STARTED, IN_PROGRESS, COMPLETED, ENTERED_IN_ERROR
answers	[object]	false	The answers given by the Health Data Intelligence consumer to questions in the Questionnaire subsection.	-
» question	object	true	A reference to the Questionnaire question that is answered.	-
»» id	string	true	The ID of the question.	-
» values	[object]	true	The values of the answer.	-
»» option	object	false	A reference to the option that is chosen as the answer.	-
»»» id	string	true	The ID of the questionnaire option.	-
»» value	string	false	A value that represents the answer to the question. The following values are accepted for different types of questions: - `TEXT` A long, potentially multiparagraph free-text answer. The maximum length is 65,535 characters. - `STRING` A short free-text answer. The maximum length is 255 characters. - `DATE_TIME` A date and time answer in ISO 8601 YYYY-MM-DDThh:mm:ssTZD format. - `CHOICE` No answer value can be specified for this type of question. - `DATE` A date answer in ISO 8601 YYYY-MM-DD format. - `OPEN_CHOICE` A long, potentially multiparagraph free-text answer that is paired with options. The maximum length is 65,535 characters. - `RANGE` A number between a high and a low value specified by the question with a precision that does not exceed 10 and a scale that does not exceed 3.	-

putQuestionnaireResponseDefinitionsQuestionnaireresponsedefinitionidResponseSubsections

Name	Type	Required	Description	Accepted Values
subsection	object	true	A reference to the Questionnaire subsection.	-
» id	string	true	The ID of the questionnaire subsection.	-
status	string	false	The current state of the Questionnaire response subsection. Currently, the following statuses are supported: - `NOT_STARTED` Indicates that the Health Data Intelligence consumer has not started answering the Questionnaire subsection. - `IN_PROGRESS` Indicates that the Health Data Intelligence consumer is currently answering the Questionnaire subsection. - `COMPLETED` Indicates that the Health Data Intelligence consumer has finished answering the Questionnaire subsection.	NOT_STARTED, IN_PROGRESS, COMPLETED, ENTERED_IN_ERROR
answers	[object]	false	The answers given by the Health Data Intelligence consumer to questions in the Questionnaire subsection.	-
» question	object	true	A reference to the Questionnaire question that is answered.	-
»» id	string	true	The ID of the question.	-
» values	[object]	true	The values of the answer.	-
»» option	object	false	A reference to the option that is chosen as the answer.	-
»»» id	string	true	The ID of the questionnaire option.	-
»» value	string	false	A value that represents the answer to the question. The following values are accepted for different types of questions: - `TEXT` A long, potentially multiparagraph free-text answer. The maximum length is 65,535 characters. - `STRING` A short free-text answer. The maximum length is 255 characters. - `DATE_TIME` A date and time answer in ISO 8601 YYYY-MM-DDThh:mm:ssTZD format. - `CHOICE` No answer value can be specified for this type of question. - `DATE` A date answer in ISO 8601 YYYY-MM-DD format. - `OPEN_CHOICE` A long, potentially multiparagraph free-text answer that is paired with options. The maximum length is 65,535 characters. - `RANGE` A number between a high and a low value specified by the question with a precision that does not exceed 10 and a scale that does not exceed 3.	-

PublishedQuestionnaireLists

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

ConsumerEngagementPublicApi_Entities_V1_Questionnaires_PublishedQuestionnaireList

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the published questionnaire.	-
name	string	true	The name of the published questionnaire.	-
type	string	true	The type of the published questionnaire.	-
createdAt	string(date-time)	true	The date and time the published questionnaire was created, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-

postPublishedQuestionnaires

Name	Type	Required	Description	Accepted Values
questionnaireDefinition	object	true	A reference to the Questionnaire definition that is used to create a published Questionnaire.	-
» id	string	true	The ID of the Questionnaire definition.	-

ConsumerEngagementPublicApi_Entities_V1_Questionnaires_PublishedQuestionnaire

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the published Questionnaire.	-
questionnaireDefinition	ConsumerEngagementPublicApi_Entities_V1_Questionnaires_Reference_Definition	false	A reference to the Questionnaire definition that is used to create a published Questionnaire.	-

ConsumerEngagementPublicApi_Entities_V1_Questionnaires_Reference_Definition

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the Questionnaire definition.	-
questionnaireId	string	true	The ID of the questionnaire. This ID does not identify an actual resource. It represents the concept of a Questionnaire.	-
name	string	true	The name of the Questionnaire. The value of this attribute is unique for every questionnaireID value.	-
type	string	true	Describes the type of the questionnaire. At present, the only allowable values are `PHA` and `CAMPAIGN`.	-
locale	string	true	The locale of the Questionnaire.	-
description	string	false	The human-readable description of the Questionnaire.	-
code	Code	false	The code from a single, specified (not fixed) code system.	-
sections	[ConsumerEngagementPublicApi_Entities_V1_Questionnaires_Reference_Section]	false	Sections are structured groups of subsections and questions for a Questionnaire.	-

ConsumerEngagementPublicApi_Entities_V1_Questionnaires_Reference_Section

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the Questionnaire section.	-
name	string	true	The name of the Questionnaire section.	-
description	string	false	The human-readable description of the Questionnaire section.	-
position	integer(int32)	true	A position of a section indicates that the section must be at the given position in the sequence of sections in the Questionnaire. The position must be unique within the Questionnaire.	-
code	ConsumerEngagementPublicApi_Entities_V1_Questionnaires_Code	false	The code of the Questionnaire section from a single, specified (not fixed) code system.	-
questions	[ConsumerEngagementPublicApi_Entities_V1_Questionnaires_Reference_Question]	false	Questions define the information necessary to guide the collection of answers from a Health Data Intelligence consumer about their health and habits.	-
subsections	[ConsumerEngagementPublicApi_Entities_V1_Questionnaires_Reference_Subsection]	false	Subsections are structured subgroups in Questionnaire sections that contain the questions for a Questionnaire.	-

ConsumerEngagementPublicApi_Entities_V1_Questionnaires_Reference_Question

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the question.	-
text	string	true	The human-readable text of the question.	-
type	string	true	The type of the question in the questionnaire. The following types are available: - `TEXT` A question with a long, potentially multiparagraph free-text answer. - `STRING` A question with a short free-text answer. The maximum length is 255 characters. - `DATE_TIME` A question with a date and time answer. - `CHOICE` A question with a choice from a list of options as an answer. - `DATE` A question with a date answer. - `OPEN_CHOICE` A question with a choice from a list of options (as with the `CHOICE` type) or a free-text answer. - `RANGE` A question with an answer that is a numeric value between a high and a low value.	TEXT, STRING, DATE_TIME, CHOICE, RANGE, DATE, OPEN_CHOICE
description	string	false	A free-text description of the questionnaire question that provides instructions or additional context for a user to answer the question.	-
acceptsMultipleAnswers	boolean	true	Indicates whether the question can have more than one answer.	-
required	boolean	true	Indicates whether the question must be answered in a completed response.	-
position	integer(int32)	true	Indicates that the question must be at the given position in the sequence of questions in the section or subsection. The position must be unique within the section or the subsection in which the question is grouped.	-
section	ConsumerEngagementPublicApi_Entities_V1_Questionnaires_Reference_QuestionnaireSectionReference	false	A reference to the questionnaire section. A question should be in either a section or a subsection.	-
subsection	ConsumerEngagementPublicApi_Entities_V1_Questionnaires_Reference_QuestionnaireSubsectionReference	false	A reference to the questionnaire subsection. A question should be in either a section or a subsection.	-
code	ConsumerEngagementPublicApi_Entities_V1_Questionnaires_Code	false	The code for the questionnaire question from a single, specified (not fixed) code system.	-
options	[ConsumerEngagementPublicApi_Entities_V1_Questionnaires_Option]	false	The possible answers to the questionnaire question.	-

ConsumerEngagementPublicApi_Entities_V1_Questionnaires_Reference_Subsection

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the questionnaire subsection.	-
name	string	true	The name of the Questionnaire subsection.	-
description	string	false	The human-readable description of the Questionnaire subsection.	-
position	integer(int32)	true	A position of a section indicates that the subsection must be at the given position in the sequence of subsections in the Questionnaire section. The position must be unique within the section in which the subsection is grouped.	-
code	ConsumerEngagementPublicApi_Entities_V1_Questionnaires_Code	false	The code of the Questionnaire subsection from a single, specified (not fixed) code system.	-
section	ConsumerEngagementPublicApi_Entities_V1_Questionnaires_Reference_QuestionnaireSectionReference	true	A reference to the Questionnaire section.	-
questions	[ConsumerEngagementPublicApi_Entities_V1_Questionnaires_Reference_Question]	false	Questions define the information necessary to guide the collection of answers from a Health Data Intelligence consumer.	-

postCompletedQuestionnaireResponses

Name	Type	Required	Description	Accepted Values
questionnaireResponse	object	true	A reference to the completed Questionnaire response.	-
» id	string	true	The ID of the questionniare response definition.	-

ConsumerEngagementPublicApi_Entities_V1_Questionnaires_CompletedQuestionnaireResponse

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the completed Questionnaire response.	-
questionnaireResponse	ConsumerEngagementPublicApi_Entities_V1_Questionnaires_Reference_Response	true	A reference to the completed Questionnaire response.	-

ConsumerEngagementPublicApi_Entities_V1_Questionnaires_Reference_Response

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the questionniare response definition.	-
authoredAt	string	true	The date and time when the questionniare response was submitted or updated. The date and time must be in ISO 8601 YYYY-MM-DDThh:mm:ssTZD format, for example, 1997-07-16T19:20:30+01:00.	-
publishedQuestionnaire	ConsumerEngagementPublicApi_Entities_V1_Questionnaires_Reference_QuestionnaireDefinitionReference	true	A reference to the Questionnaire definition.	-
consumer	ConsumerEngagementPublicApi_Entities_V1_Questionnaires_Reference_ConsumerReference	true	A reference to the Health Data Intelligence consumer.	-
responseSections	[ConsumerEngagementPublicApi_Entities_V1_Questionnaires_Reference_ResponseSection]	false	Sections are structured groups in Questionnaire responses that contain answers for a Questionnaire.	-
responseSubsections	[ConsumerEngagementPublicApi_Entities_V1_Questionnaires_Reference_ResponseSubsection]	false	Subsections are structured subgroups in Questionnaire response sections that contain the answers for a Questionnaire.	-

ConsumerEngagementPublicApi_Entities_V1_Questionnaires_Reference_ResponseSection

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the Questionnaire response section.	-
section	ConsumerEngagementPublicApi_Entities_V1_Questionnaires_Reference_QuestionnaireSectionReference	true	A reference to the Questionnaire section.	-
status	string	true	The current state of the Questionnaire response section. Currently, the following statuses are supported: - `NOT_STARTED` Indicates that the Health Data Intelligence consumer has not started answering the Questionnaire section. - `IN_PROGRESS` Indicates that the Health Data Intelligence consumer is currently answering the Questionnaire Section. - `COMPLETED` Indicates that the Health Data Intelligence consumer has finished answering the Questionnaire section.	NOT_STARTED, IN_PROGRESS, COMPLETED, ENTERED_IN_ERROR
answers	[ConsumerEngagementPublicApi_Entities_V1_Questionnaires_QuestionnaireAnswer]	false	The answers given by the Health Data Intelligence consumer to questions in the Questionnaire section.	-

ConsumerEngagementPublicApi_Entities_V1_Questionnaires_Reference_ResponseSubsection

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the Questionnaire response subsection.	-
status	string	true	The current state of the Questionnaire response subsection. Currently, the following statuses are supported: - `NOT_STARTED` Indicates that the Health Data Intelligence consumer has not started answering the Questionnaire subsection. - `IN_PROGRESS` Indicates that the Health Data Intelligence consumer is currently answering the Questionnaire subsection. - `COMPLETED` Indicates that the Health Data Intelligence consumer has finished answering the Questionnaire subsection.	NOT_STARTED, IN_PROGRESS, COMPLETED, ENTERED_IN_ERROR
subsection	ConsumerEngagementPublicApi_Entities_V1_Questionnaires_Reference_QuestionnaireSubsectionReference	true	A reference to the Questionnaire subsection.	-
answers	[ConsumerEngagementPublicApi_Entities_V1_Questionnaires_QuestionnaireAnswer]	false	The answers given by the Health Data Intelligence consumer to questions in the Questionnaire subsection.	-

postConsumersConsumeridAttachments

Name	Type	Required	Description	Accepted Values
domain	string	true	The domain associated with the given tenant and consumer.	-
media_content	file	true	The attachment file which needs to be uploaded. It should be in a file format.	-
media_attributes	file	true	The file containing attributes of the attachment being uploaded in the JSON format, mediaAttributes must have contentTypeKey attribute with value of PATIENT_PROVIDED. Other supported attributes are name and personId {“contentTypeKey”: “PATIENT_PROVIDED”, “name”: “test_attachment”, “personId”: “12560038”}. It should be in a file format.	-

ConsumerEngagementPublicApi_Entities_V1_HealthelifeMessaging_Attachment

Name	Type	Required	Description	Accepted Values
id	string	true	The Millennium media identifier of the uploaded attachment.	-
version	string	true	The version of the uploaded attachment.	-
attachmentName	string	false	The name of the uploaded attachment.	-
contentType	string	true	The content type of the uploaded attachment.	-
patientId	string	false	The Millennium patient identifier of the uploaded attachment.	-

UnreadMessageCounts

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

ConsumerEngagementPublicApi_Entities_V1_HealthelifeMessaging_UnreadMessageCount

Name	Type	Required	Description	Accepted Values
domain	string	true	The domain to which the consumer belongs.	-
unreadMessageCounts	string	true	The list of patients and the count of their unread messages from Inbox folder	-

ConsumerEngagementPublicApi_Entities_V1_HealthelifeMessaging_MessageDetail

Name	Type	Required	Description	Accepted Values
millenniumMessageId	string	true	The Cerner Millennium ID of the message.	-
domain	string	true	The domain from the given tenant.	-
millenniumPreviousMessageId	string	true	The Cerner Millennium ID of the previous message in the thread.	-
patientId	string	false	The ID of a patient.	-
senderId	string	true	The ID of a sender.	-
senderType	string	true	The type of a sender.	PERSON, PERSONNEL, POOL
senderName	string	true	The name of a sender. In case of sender type PERSON, the sender name is empty.	-
sentDate	string(date-time)	true	The date and time when the message was sent.	-
hasAttachment	boolean	true	A boolean value indicating if the message has attachments or not.	-
canReply	boolean	false	The flag to indicate if a message can be replied to or not. If a message is the last message in the chain, this flag is false, indicating that a consumer cannot reply to this message.	-
recipients	[ConsumerEngagementPublicApi_Entities_V1_HealthelifeMessaging_MessageRecipient]	true	The recipients of the message.	-
ccRecipients	[ConsumerEngagementPublicApi_Entities_V1_HealthelifeMessaging_MessageRecipient]	true	The carbon copy recipients of the message.	-
subject	string	true	The subject of the message.	-
recipientMessageStatus	string	true	The status of the message corresponding to a specific consumer.	-
body	[ConsumerEngagementPublicApi_Entities_V1_HealthelifeMessaging_MessageBody]	false	The body of the message. The body of the message will only be exposed in the details of a specific message.	-
attachments	[ConsumerEngagementPublicApi_Entities_V1_HealthelifeMessaging_MessageAttachment]	false	Attachments to the message. The attachments will only be exposed in the details of a specific message.	-

ConsumerEngagementPublicApi_Entities_V1_HealthelifeMessaging_MessageRecipient

Name	Type	Required	Description	Accepted Values
id	string	true	The Cerner Millennium ID of the message recipient.	-
type	string	true	The type of the recipient.	PERSONNEL, POOL, PERSON
displayName	string	false	The name of the recipient. In case of recipient type PERSON, the display name is empty.	-

ConsumerEngagementPublicApi_Entities_V1_HealthelifeMessaging_MessageBody

Name	Type	Required	Description	Accepted Values
formatType	string	true	The format of the text in the body.	XHTML, RTF, UNKNOWN
text	string	true	The text of the message body.	-

ConsumerEngagementPublicApi_Entities_V1_HealthelifeMessaging_MessageAttachment

Name	Type	Required	Description	Accepted Values
name	string	true	The name of the attachment.	-
mediaIdentifier	string	true	Media identifier of the attachment.	-
mediaVersion	integer(int32)	true	Media version of the attachment.	-

putConsumersConsumeridMessages

Name	Type	Required	Description	Accepted Values
status	string	true	The status to update the message with. Supported status values are UNREAD, OPEN, DELETE.	-
domain	string	true	The domain from the given tenant.	-
patientId	string	true	The ID of a patient.	-

postConsumersConsumeridMessagesBatchModify

Name	Type	Required	Description	Accepted Values
messages	[object]	true	The IDs of the messages to be modified.	-
consumerFolderId	string	true	The ID of the folder where messages are to be moved.	-

postConsumersConsumeridMessages

Name	Type	Required	Description	Accepted Values
domain	string	true	The domain from the given tenant.	-
patientId	string	true	The ID of a patient.	-
millenniumPreviousMessageId	string	false	The Cerner Millennium ID of the previous message in the thread.	-
messageType	string	true	Message types are pre-defined keys to describe what type of message the consumer is sending to the recipient. Supported message types are GENERAL, APPOINTMENT_SCHEDULE, APPOINTMENT_RESCHEDULE, APPOINTMENT_CANCEL, MEDICATION_REFILL, PRESCRIPTION_RENEWAL, PATIENT_INFORMATION.	-
recipients	[ConsumerEngagementPublicApi_Entities_V1_HealthelifeMessaging_MessageRecipient]	true	The recipients of the message.	-
subject	string	true	The subject of the message.	-
body	[ConsumerEngagementPublicApi_Entities_V1_HealthelifeMessaging_MessageBody]	true	The body of the message. The body of the message will only be exposed in the details of a specific message.	-
attachments	[ConsumerEngagementPublicApi_Entities_V1_HealthelifeMessaging_MessageAttachment]	false	Attachments to the message.	-

ConsumerEngagementPublicApi_Entities_V1_HealthelifeMessaging_CreateMessageResponse

Name	Type	Required	Description	Accepted Values
millenniumMessageId	string	true	The Cerner Millennium ID of the message.	-
domain	string	true	The domain from the given tenant.	-
sentDate	string(date-time)	true	The date and time when the message was sent.	-

MessageDetails

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

putConsumersConsumeridFolders

Name	Type	Required	Description	Accepted Values
name	string	true	The name of the folder. System reserved names such as INBOX, SENT, and TRASH are not permitted.	-
domain	string	true	The domain or location associated with the tenant	-

ConsumerEngagementPublicApi_Entities_V1_HealthelifeMessaging_Folder

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the folder.	-
consumerId	string	true	The ID of a consumer.	-
name	string	true	The name of the folder. System reserved names such as INBOX, SENT, and TRASH are not permitted.	-
domain	string	true	The domain or location associated with the tenant.	-
type	string	true	The type of the folder.	INBOX, SENT, TRASH, PERMANENT_DELETE, CUSTOM
createdAt	string(date-time)	true	The date and time when the record was created in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-
updatedAt	string(date-time)	true	The date and time when the record was last updated in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-

Folders

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

postConsumersConsumeridFolders

Name	Type	Required	Description	Accepted Values
name	string	true	The name of the folder. System reserved names such as INBOX, SENT, and TRASH are not permitted.	-
domain	string	true	The domain or location associated with the tenant	-

RoutingRules

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

ConsumerEngagementPublicApi_Entities_V1_HealthelifeMessaging_RoutingRule

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the routing rule.	-
domain	string	true	The domain with which the routing rule is associated.	-
messageType	string	true	Message types are pre-defined keys to describe what type of message the consumer is sending to the recipient. Supported message types are GENERAL, APPOINTMENT_SCHEDULE, APPOINTMENT_RESCHEDULE, APPOINTMENT_CANCEL, MEDICATION_REFILL, PRESCRIPTION_RENEWAL, PATIENT_INFORMATION.	-
intendedPersonnel	[ConsumerEngagementPublicApi_Entities_V1_HealthelifeMessaging_RoutingRulePersonnel]	false	Details of intended personnel associated with the routing rule.	-
routedPersonnel	[ConsumerEngagementPublicApi_Entities_V1_HealthelifeMessaging_RoutingRulePersonnel]	false	Details of routed personnel associated with the routing rule.	-
intendedPool	[ConsumerEngagementPublicApi_Entities_V1_HealthelifeMessaging_RoutingRulePool]	false	Details of intended pool associated with the routing rule.	-
routedPool	[ConsumerEngagementPublicApi_Entities_V1_HealthelifeMessaging_RoutingRulePool]	false	Details of routed pool associated with the routing rule.	-
createdAt	string(date-time)	true	The date and time when a routing rule was created in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-
updatedAt	string(date-time)	true	The date and time when a routing rule was last updated in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-

ConsumerEngagementPublicApi_Entities_V1_HealthelifeMessaging_RoutingRulePersonnel

Name	Type	Required	Description	Accepted Values
id	string	true	The identifier of the personnel associated with the routing rule.	-
millenniumId	string	true	The millennium identifier of the personnel associated with the routing rule.	-
displayName	string	true	The display name of the personnel associated with the routing rule.	-

ConsumerEngagementPublicApi_Entities_V1_HealthelifeMessaging_RoutingRulePool

Name	Type	Required	Description	Accepted Values
id	string	true	The identifier of the pool associated with the routing rule.	-
millenniumId	string	true	The millennium identifier of the pool associated with the routing rule.	-
displayName	string	true	The display name of the pool associated with the routing rule.	-

postRoutingRules

Name	Type	Required	Description	Accepted Values
domain	string	true	The domain with which the routing rule is associated.	-
messageType	string	true	Message types are pre-defined keys to describe what type of message the consumer is sending to the recipient. Supported message types are GENERAL, APPOINTMENT_SCHEDULE, APPOINTMENT_RESCHEDULE, APPOINTMENT_CANCEL, MEDICATION_REFILL, PRESCRIPTION_RENEWAL, PATIENT_INFORMATION.	-
intendedPersonnelId	string	false	ID of the personnel to which the message is intended but not sent to. A routing rule must have an intendedPersonnelId or an intendedPoolId, but it may not have both.	-
intendedPoolId	string	false	ID of the pool to which the message is intended but not sent to. A routing rule must have an intendedPersonnelId or an intendedPoolId, but it may not have both.	-
routedPersonnelId	string	false	ID of the personnel to which the message is actually routed. A routing rule must have at least one of the routedPersonnelId or routedPoolId.	-
routedPoolId	string	false	ID of the pool to which the message is actually routed. A routing rule must have at least one of the routedPersonnelId or routedPoolId.	-

putRoutingRules

Name	Type	Required	Description	Accepted Values
routedPersonnelId	string	false	ID of the personnel to which the message is actually routed. A routing rule must have at least one of the routedPersonnelId or routedPoolId.	-
routedPoolId	string	false	ID of the pool to which the message is actually routed. A routing rule must have at least one of the routedPersonnelId or routedPoolId.	-

postRoutingRulesBatchUpsert

Name	Type	Required	Description	Accepted Values
domain	string	true	The domain for which routing rules are to be created.	-
routing_rules_file	file	true	The CSV file that contains information about routing rules to be created/updated.	-

ConsumerEngagementPublicApi_Entities_V1_HealthelifeMessaging_BatchUpsertRoutingRuleResponse

Name	Type	Required	Description	Accepted Values
routingRulesFound	string	true	The number of rows found in the CSV file	-
routingRulesCreated	string	true	The number of routing rules that were created from the data in the CSV file	-
routingRulesUpdated	string	true	The number of routing rules that were updated from the data in the CSV file	-
errorDetails	[ConsumerEngagementPublicApi_Entities_V1_HealthelifeMessaging_ErrorDetails]	true	Errors that occurred while processing the CSV file.	-

ConsumerEngagementPublicApi_Entities_V1_HealthelifeMessaging_ErrorDetails

Name	Type	Required	Description	Accepted Values
line	string	true	The line number in the CSV file for which the error occurred	-
messages	[string]	true	Errors that occurred while processing the current line	-

MessagingConfigs

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

ConsumerEngagementPublicApi_Entities_V1_HealthelifeMessaging_MessagingConfig

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the messaging configuration.	-
domain	string	true	The domain with which the messaging configuration is associated.	-
messagingEnabled	boolean	true	The configuration to denote whether the messaging feature is enabled for this domain.	-
preDefinedSubjectEnabled	boolean	true	The configuration to denote whether the pre-defined subject is enabled for this domain.	-
attachmentsEnabled	boolean	true	The configuration to denote whether the attachments are supported for messages.	-
addRecipientInSubject	boolean	true	The configuration to denote whether the intended recipient of the message should be added in subject line.	-
sensitiveMessaging	boolean	true	The configuration to denote whether the portal users while sending the message can select who else from their list of authorized users will have access to this message.	-
relationshipBasedMessaging	boolean	true	The configuration to denote whether the portal users can send new messages only to messageable providers with whom they have established either person-level or encounter-level relationships.	-
locale	string	true	The locale with which this messaging configuration is associated.	-
createdAt	string(date-time)	true	The date and time when a messaging configuration was created in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-
updatedAt	string(date-time)	true	The date and time when a messaging configuration was last updated in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-

postMessagingConfigs

Name	Type	Required	Description	Accepted Values
domain	string	true	The domain with which the messaging configuration is associated.	-
locale	string	true	The locale with which this messaging configuration is associated.	-
messagingEnabled	boolean	false	The configuration to denote whether the messaging feature is enabled for this domain.	-
preDefinedSubjectEnabled	boolean	false	The configuration to denote whether the pre-defined subject is enabled for this domain.	-
attachmentsEnabled	boolean	false	The configuration to denote whether the attachments are supported for messages.	-
addRecipientInSubject	boolean	false	The configuration to denote whether the intended recipient of the message should be added in subject line.	-
sensitiveMessaging	boolean	false	The configuration to denote whether the portal users while sending the message can select who else from their list of authorized users will have access to this message.	-
relationshipBasedMessaging	boolean	false	The configuration to denote whether the portal users can send new messages only to messageable providers with whom they have established either person-level or encounter-level relationships.	-

putMessagingConfigs

Name	Type	Required	Description	Accepted Values
domain	string	true	The domain with which the messaging configuration is associated.	-
locale	string	true	The locale with which this messaging configuration is associated.	-
messagingEnabled	boolean	true	The configuration to denote whether the messaging feature is enabled for this domain.	-
preDefinedSubjectEnabled	boolean	true	The configuration to denote whether the pre-defined subject is enabled for this domain.	-
attachmentsEnabled	boolean	true	The configuration to denote whether the attachments are supported for messages.	-
addRecipientInSubject	boolean	true	The configuration to denote whether the intended recipient of the message should be added in subject line.	-
sensitiveMessaging	boolean	true	The configuration to denote whether the portal users while sending the message can select who else from their list of authorized users will have access to this message.	-
relationshipBasedMessaging	boolean	true	The configuration to denote whether the portal users can send new messages only to messageable providers with whom they have established either person-level or encounter-level relationships.	-

Pools

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

ConsumerEngagementPublicApi_Entities_V1_HealthelifeMessaging_Pool

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the pool.	-
domain	string	true	The domain with which this pool is associated.	-
millenniumPoolId	string	true	The Cerner Millennium ID of the pool.	-
millenniumName	string	true	The Cerner Millennium name of the pool.	-
displayName	string	true	The Health Data Intelligence display name of the pool.	-
isMessageable	boolean	true	Indicates whether or not this pool is currently messageable by patients.	-
createdAt	string(date-time)	true	The date and time when this pool was created in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-
updatedAt	string(date-time)	true	The date and time when this pool was last updated in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-

putPools

Name	Type	Required	Description	Accepted Values
domain	string	true	The domain with which the pool is associated.	-
millenniumPoolId	string	true	The ID of the Cerner Millennium pool.	-
displayName	string	true	The name of the pool in HealtheLife Messaging.	-

Personnels

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

ConsumerEngagementPublicApi_Entities_V1_HealthelifeMessaging_Personnel

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the personnel.	-
domain	string	true	The domain with which this personnel is associated.	-
millenniumPersonnelId	string	true	The Cerner Millennium ID of the personnel.	-
millenniumName	string	true	The Cerner Millennium name of the personnel.	-
displayName	string	true	The Health Data Intelligence display name of the personnel.	-
isMessageable	boolean	true	Indicates whether or not this personnel is currently messageable by patients.	-
personnelAlias	string	true	A field that uniquely identifies a personnel.	-
createdAt	string(date-time)	true	The date and time when this personnel was created in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-
updatedAt	string(date-time)	true	The date and time when this personnel was last updated in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-

postPersonnels

Name	Type	Required	Description	Accepted Values
domain	string	true	The domain with which the personnel is associated.	-
millenniumPersonnelId	string	true	The ID of the Cerner Millennium personnel.	-
displayName	string	true	The name of the personnel in HealtheLife Messaging.	-

putPersonnels

Name	Type	Required	Description	Accepted Values
domain	string	true	The domain with which the personnel is associated.	-
millenniumPersonnelId	string	true	The ID of the Cerner Millennium personnel.	-
displayName	string	true	The name of the personnel in HealtheLife Messaging.	-

postPersonnelsBatchUpsert

Name	Type	Required	Description	Accepted Values
domain	string	true	The domain for which personnel are to be created.	-
personnel_file	file	true	The CSV file that contains information about personnel to be created/updated.	-

ConsumerEngagementPublicApi_Entities_V1_HealthelifeMessaging_BatchUpsertPersonnelResponse

Name	Type	Required	Description	Accepted Values
personnelFound	string	true	The number of rows found in the CSV file	-
personnelCreated	string	true	The number of personnel that were created from the data in the CSV file	-
personnelUpdated	string	true	The number of personnel that were updated from the data in the CSV file	-
errorDetails	[ConsumerEngagementPublicApi_Entities_V1_HealthelifeMessaging_ErrorDetails]	true	Errors that occurred while processing the CSV file.	-

SyncRecipients

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

ConsumerEngagementPublicApi_Entities_V1_HealthelifeMessaging_SyncRecipient

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the sync recipient record.	-
domain	string	true	The domain for which the recipients are to be synced.	-
recipientType	string	true	The type of recipients to be synced	PERSONNEL, POOL
status	string	true	The current status of the sync recipient request.	NOT_STARTED, IN_PROGRESS, COMPLETED, ERROR
statusDetail	string	true	A short description describing the current status of the sync recipient request.	-
createdAt	string(date-time)	true	The date and time when a sync recipient record was created in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-
updatedAt	string(date-time)	true	The date and time when a sync recipient record was last updated in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-

postSyncRecipients

Name	Type	Required	Description	Accepted Values
domain	string	true	The domain for which the recipients are to be synced.	-
recipientType	string	true	The type of recipients to be synced	POOL, PERSONNEL

MessageRecipientLists

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

ConsumerEngagementPublicApi_Entities_V1_HealthelifeMessaging_MessageRecipientList

Name	Type	Required	Description	Accepted Values
patientId	string	true	The Cerner Millennium identifier of a patient.	-
recipients	[ConsumerEngagementPublicApi_Entities_V1_HealthelifeMessaging_MessageRecipient]	true	The list of messageable recipients. Recipients can be of type PERSONNEL or POOL.	-

PreDefinedSubjects

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

ConsumerEngagementPublicApi_Entities_V1_HealthelifeMessaging_PreDefinedSubject

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the predefined subject record.	-
domain	string	true	The domain with which the predefined subject is associated.	-
subject	string	true	The predefined subject string. The predefined subject option is available only when pre_defined_subject_enabled is set to True in messaging configurations for this domain.	-
locale	string	true	The locale with which the predefined subject is associated.	-
createdAt	string(date-time)	true	The date and time when a predefined subject record was created in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-
updatedAt	string(date-time)	true	The date and time when a predefined subject record was last updated in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-

postPreDefinedSubjects

Name	Type	Required	Description	Accepted Values
domain	string	true	The domain with which the predefined subject is associated.	-
subject	string	true	The predefined subject string. The predefined subject option is available only when pre_defined_subject_enabled is set to True in messaging configurations for this domain.	-
locale	string	true	The locale with which the predefined subject is associated.	-

putPreDefinedSubjects

Name	Type	Required	Description	Accepted Values
domain	string	true	The domain with which the predefined subject is associated.	-
subject	string	true	The predefined subject string. The predefined subject option is available only when pre_defined_subject_enabled is set to True in messaging configurations for this domain.	-
locale	string	true	The locale with which the predefined subject is associated.	-

postPatientsPatientidClipboardsClipboardidSectionsSectionidFormsFormidQuestionResponses

Name	Type	Required	Description	Accepted Values
responses	[object]	true	The responses submitted for the questions on this questionnaire.	-
» questionId	string	true	The ID of the question that this response belongs to.	-
» answer	object	true	The answer submitted by the patient for this question.	-
»» value	string	false	The value submitted for this answer. This is accepted for the following question types only: DATE, NUMERIC, TEXT, FREE_TEXT, ALPHA_AND_FREE_TEXT, MULTI_ALPHA_AND_FREE_TEXT. The ALPHA_AND_FREE_TEXT question type cannot be specified if selectedChoices is specified.	-
»» selectedChoices	[object]	false	The choices selected for this answer. This is accepted for the following question types only: ALPHA, ALPHA_AND_FREE_TEXT, MULTI, MULTI_ALPHA_AND_FREE_TEXT. The ALPHA_AND_FREE_TEXT question type cannot be specified if a value is specified.	-
»»» nomenclatureId	string	true	The ID of the selected choice.	-
createdById	string	true	The ID of the person who created the questionnaire response.	-

putPatientsPatientidClipboards

Name	Type	Required	Description	Accepted Values
status	string	true	The new status of the clipboard. The following values are supported: `IN_PROGRESS`, `ABORTED`, `INVALID`.	IN_PROGRESS, ABORTED, INVALID
updatedById	string	true	The ID of the user who is updating the clipboard.	-
updatedByProxy	boolean	true	Whether the update is being performed by a proxy.	-

ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_ClipboardSingleItem

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the clipboard.	-
status	string	true	The clipboard status. The following values are supported: `NOT_STARTED`, `IN_PROGRESS`, `IN_REVIEW`, `COMPLETED`, `ABORTED`, `INVALID`.	NOT_STARTED, IN_PROGRESS, IN_REVIEW, COMPLETED, ABORTED, INVALID
nameFriendly	string	true	The patient-facing name of the clipboard.	-
policyText	string	false	The policy text displayed on the clipboard.	-
requestRemovalPolicyText	string	false	The removal policy text displayed for the clipboard.	-
successMessagePolicyText	string	true	The success policy text displayed for the clipboard.	-
event	ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_Events_Event	true	The event that caused this clipboard to be assigned to the patient.	-
sections	[ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_Section]	true	An array of sections associated with the clipboard.	-

ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_Events_Event

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the event.	-
type	string	true	The event type that caused the clipboard to be assigned to the patient. The following values are supported: `ENCOUNTER`, `APPOINTMENT`, `OPTIONAL`.	ENCOUNTER, APPOINTMENT, OPTIONAL
locationId	string	false	The ID of the appointment or encounter location in Cerner Millennium.	-
appointment	ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_Events_AppointmentEvent	false	The details for an event type of APPOINTMENT.	-
encounter	ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_Events_EncounterEvent	false	The details for an event type of ENCOUNTER.	-

ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_Events_AppointmentEvent

Name	Type	Required	Description	Accepted Values
id	string	false	The ID of the appointment event in Cerner Millennium. Note: This field should only be specified if the event type is APPOINTMENT.	-
appointmentAt	string	false	The date and time of the appointment. Note: This field should only be specified if the event type is APPOINTMENT.	-
appointmentTypeId	string	false	The ID of the appointment type in Cerner Millennium. Note: This field should only be specified if the event type is APPOINTMENT.	-
provider	string	false	The name of the provider. Note: This field should only be specified if the event type is APPOINTMENT.	-

ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_Events_EncounterEvent

Name	Type	Required	Description	Accepted Values
id	string	false	The ID of the encounter in Cerner Millennium. Note: This field should only be specified if the event type is ENCOUNTER.	-
personnelId	string	false	The ID of the personnel associated with the encounter in Cerner Millennium. Note: This field should only be specified if the event type is ENCOUNTER.	-
poolId	string	false	The ID of the pool associated with the encounter in Cerner Millennium. Note: This field should only be specified if the event type is ENCOUNTER.	-

ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_Section

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the clipboard section.	-
name	string	true	The name of the clipboard section.	-
description	string	true	The description of the clipboard section.	-
millenniumDocumentCode	string	true	The Cerner Millennium document code associated with the clipboard section.	-
position	integer(int32)	true	The position of the section within the clipboard.	-
createdAt	string	true	The date and time when the section was created.	-
updatedAt	string	true	The date and time when the section was updated.	-
patientFinished	boolean	true	Indicates whether the patient has completed filling out the section.	-
forms	[ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_FormReference]	true	An array of forms associated with the section.	-

ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_FormReference

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the form.	-
nameFriendly	string	true	The form name displayed to the patient.	-
position	integer(int32)	true	The position of the form in the section.	-
isSensitive	boolean	true	Indicates whether the form contains sensitive content that should not be displayed to proxies of adolescents. This only applies if the form type is CUSTOM.	-
type	string	true	The type of form. The following values are supported: `STANDARD`, `CUSTOM`	STANDARD, CUSTOM
formConfigId	string	true	The ID of the Config Form.	-
codifiedLists	[ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_CodifiedList]	true	List of codified lists. This is only present if the form type is STANDARD.	-
createdAt	string	true	The date and time when the form was created.	-
updatedAt	string	true	The date and time when the form was last updated by the patient.	-
updatedByProxy	boolean	true	Whether the patient form was updated by a proxy or not.	-
patientFinished	boolean	true	Indicates whether the patient has completed the form.	-

ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_CodifiedList

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of Codified List.	-
name	string	true	The name of codified list.	-
type	string	true	The codified list type. The following values are supported: [ALLERGIES, REACTIONS, HEALTH_ISSUES, PROCEDURES_AND_SURGERIES, IMMUNIZATIONS, FAMILY_HISTORY].	ALLERGIES, REACTIONS, HEALTH_ISSUES, PROCEDURES_AND_SURGERIES, IMMUNIZATIONS, FAMILY_HISTORY

ClipboardListItems

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

ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_ClipboardListItem

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the clipboard.	-
clipboardLink	string	true	The deep link used to take a user directly to the clipboard from another application.	-
status	string	true	The clipboard status. The following values are supported: `NOT_STARTED`, `IN_PROGRESS`, `IN_REVIEW`, `COMPLETED`, `ABORTED`, `INVALID`.	NOT_STARTED, IN_PROGRESS, IN_REVIEW, COMPLETED, ABORTED, INVALID
nameFriendly	string	true	The patient-facing name of the clipboard.	-
createdAt	string	true	The date and time when the clipboard was created.	-
startedAt	string	false	The date and time when the clipboard was started by the patient.	-
updatedAt	string	true	The date and time when the clipboard was last updated by the patient.	-
event	ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_Events_Event	true	The event that caused this clipboard to be assigned to the patient.	-
clipboardId	string	true	The ID of the clipboard configuration.	-

postPatientsPatientidClipboardEvents

Name	Type	Required	Description	Accepted Values
eventType	string	true	The event type that caused the clipboard to be assigned to the patient. The following values are supported: `ENCOUNTER`, `APPOINTMENT`, `OPTIONAL`.	ENCOUNTER, APPOINTMENT, OPTIONAL
locationId	string	false	The ID of the appointment or encounter location in Cerner Millennium.	-
appointmentEvent	object	true	The details for an event type of APPOINTMENT.	-
» id	string	true	The ID of the appointment event in Cerner Millennium. Note: This field should only be specified if the event type is APPOINTMENT.	-
» appointmentTypeId	string	true	The ID of the appointment type in Cerner Millennium. Note: This field should only be specified if the event type is APPOINTMENT.	-
» appointmentAt	string	true	The date and time of the appointment. Note: This field should only be specified if the event type is APPOINTMENT.	-
» provider	string	false	The name of the provider. Note: This field should only be specified if the event type is APPOINTMENT.	-
encounterEvent	object	true	The details for an event type of ENCOUNTER.	-
» id	string	true	The ID of the encounter in Cerner Millennium. Note: This field should only be specified if the event type is ENCOUNTER.	-
» clipboards	[object]	true	The IDs of the clipboards to be assigned to the patient. Note: The IDs should only be specified if the event type is ENCOUNTER.	-
»» id	string	true	No description	-
» personnelId	string	false	The ID of the personnel associated with the encounter in Cerner Millennium. Note: This field should only be specified if the event type is ENCOUNTER.	-
» poolId	string	false	The ID of the pool associated with the encounter in Cerner Millennium. Note: This field should only be specified if the event type is ENCOUNTER.	-
createdById	string	true	The ID of the person who created the clipboard event.	-

ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_ClipboardEvent

Name	Type	Required	Description	Accepted Values
event	ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_Events_Event	true	The event details for the clipboard event.	-
clipboardsBaseUrl	string	true	The URL of the landing page for the clipboard.	-
clipboards	[ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_ClipboardReference]	true	The clipboards to be assigned to the patient based on this event.	-

ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_ClipboardReference

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the patient’s clipboard.	-
link	string	true	The deep link used to take a user directly to the patient’s clipboard from another application.	-
status	string	true	The clipboard status. The following values are supported: `NOT_STARTED`, `IN_PROGRESS`, `IN_REVIEW`, `COMPLETED`, `ABORTED`, `INVALID`.	NOT_STARTED, IN_PROGRESS, IN_REVIEW, COMPLETED, ABORTED, INVALID

postPatientsPatientidClipboardsClipboardidSubmission

Name	Type	Required	Description	Accepted Values
submittedBy	object	true	The information of the person that is submitting the clipboard.	-
» fullName	string	true	The full name of the person that is submitting the clipboard.	-
» isProxy	boolean	true	Whether it is being submitted by a proxy.	-

putPatientsPatientidClipboardsClipboardidSectionsSectionidForms

Name	Type	Required	Description	Accepted Values
patientFinished	boolean	true	Indicates whether the patient has completed the form.	-
updatedById	string	true	The ID of the user that last updated the form.	-
updatedByProxy	boolean	false	Whether the patient form was updated by a proxy or not.	-

ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_FormSingleItem

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the form.	-
nameFriendly	string	true	The form name displayed to the patient.	-
policyText	string	true	The policy text displayed on the form.	-
allowFreeText	boolean	true	Indicates whether free-text can be entered in the form. This only applies if the form type is STANDARD.	-
isSensitive	boolean	true	Indicates whether the form contains sensitive content that should not be displayed to proxies of adolescents. This only applies if the form type is CUSTOM.	-
standardFormType	string	false	The standard form type if the form type is STANDARD. The following values are supported: `ALLERGIES`, `CONDITIONS`, `FAMILY_HISTORY`, `IMMUNIZATIONS`, `MEDICATIONS`, `PROCEDURES`, `SOCIAL_HISTORY`	ALLERGIES, CONDITIONS, FAMILY_HISTORY, IMMUNIZATIONS, MEDICATIONS, PROCEDURES, SOCIAL_HISTORY
type	string	true	The type of form. The following values are supported: `STANDARD`, `CUSTOM`	STANDARD, CUSTOM
formConfigId	string	true	The ID of the Config Form.	-
codifiedLists	[ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_CodifiedList]	true	List of codified lists. This is only present if the form type is STANDARD.	-
createdAt	string	true	The date and time when the form was created.	-
updatedAt	string	true	The date and time when the form was last updated by the patient.	-
updatedById	string	true	The ID of the user that last updated the form.	-
updatedByProxy	boolean	true	Whether the patient form was updated by a proxy or not.	-
patientFinished	boolean	true	Indicates whether the patient has completed the form.	-
allergies	[ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_FormItems_AllergyItem]	true	An array of allergy items associated with the form.	-
procedures	[ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_FormItems_ProcedureItem]	true	An array of procedure items associated with the form.	-
medications	[ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_FormItems_MedicationItem]	true	An array of medication items associated with the form.	-
immunizations	[ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_FormItems_ImmunizationItem]	true	An array of immunizations items associated with the form.	-
questionnaire	[ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_Questionnaires_ContentReference]	false	The questions and text boxes to be displayed on a custom form.	-
questionnaireResponse	ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_Questionnaires_QuestionnaireResponse	false	The response submitted by the patient for this questionnaire.	-

ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_FormItems_AllergyItem

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the EMR or patient-entered item.	-
name	string	true	The name of the item.	-
comments	string	false	Patient-entered comments regarding the item.	-
createdAt	string	true	The date and time when the item was created.	-
updatedAt	string	true	The date and time when the item was updated.	-
source	string	true	The item type. The following values are supported: `EMR`, `PATIENT`.	EMR, PATIENT
status	string	true	The item status. If the source is PATIENT the following values are supported: `ADD`. If the source is EMR the following values are supported: `UPDATE`, `KEEP`, `DELETE`.	ADD, UPDATE, KEEP, DELETE
nomenclatureId	string	false	The nomenclature ID of the allergy.	-
reactions	[ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_FormItems_Reaction]	false	An array of reactions associated with an allergy item.	-

ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_FormItems_Reaction

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the allergic reaction.	-
name	string	true	The name of the reaction.	-
nomenclatureId	string	false	The nomenclature ID of the reaction.	-
createdAt	string	true	The date and time when the reaction was created.	-
updatedAt	string	true	The date and time when the reaction was updated.	-

ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_FormItems_ProcedureItem

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the EMR or patient-entered item.	-
name	string	true	The name of the item.	-
comments	string	false	Patient-entered comments regarding the item.	-
createdAt	string	true	The date and time when the item was created.	-
updatedAt	string	true	The date and time when the item was updated.	-
source	string	true	The item type. The following values are supported: `EMR`, `PATIENT`.	EMR, PATIENT
status	string	true	The item status. If the source is PATIENT the following values are supported: `ADD`. If the source is EMR the following values are supported: `KEEP`, `UPDATE`.	ADD, KEEP, UPDATE
approximateDate	string	false	The approximate date when the procedure was performed. Available formats: YYYY, YYYY-MM, YYYY-MM-DD	-
nomenclatureId	string	false	The nomenclature ID of the procedure.	-

ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_FormItems_MedicationItem

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the EMR or patient-entered item.	-
name	string	true	The name of the item.	-
comments	string	false	Patient-entered comments regarding the item.	-
createdAt	string	true	The date and time when the item was created.	-
updatedAt	string	true	The date and time when the item was updated.	-
source	string	true	The item type. The following values are supported: `EMR`, `PATIENT`.	EMR, PATIENT
status	string	true	The item status. If the source is PATIENT the following values are supported: `ADD`. If the source is EMR the following values are supported: `KEEP`, `UPDATE`.	ADD, KEEP, UPDATE
synonymId	string	false	The synonym ID of the medication.	-
dose	string	false	The dose of the medication.	-
frequency	string	false	Frequency of the medication.	-
prescribingProvider	string	false	Provider who prescribed the medication.	-
userStatus	string	true	The user status. The following values are supported: `NOT_SURE`, `AS_PRESCRIBED`, `NOT_TAKING`, `NOT_AS_PRESCRIBED`.	-
userStatusLabel	string	true	The user status label.	-

ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_FormItems_ImmunizationItem

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the EMR or patient-entered item.	-
name	string	true	The name of the item.	-
comments	string	false	Patient-entered comments regarding the item.	-
createdAt	string	true	The date and time when the item was created.	-
updatedAt	string	true	The date and time when the item was updated.	-
source	string	true	The item type. The following values are supported: `EMR`, `PATIENT`.	EMR, PATIENT
status	string	true	The item status. If the source is PATIENT the following values are supported: `ADD`.If the source is EMR the following values are supported: `KEEP`.	ADD, KEEP
eventCode	string	false	The event code of the immunization.	-
approximateDate	string	true	Approximate date the immunization was received. Available formats: YYYY, YYYY-MM, YYYY-MM-DD	-

ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_Questionnaires_ContentReference

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of a specific content.	-
type	string	true	The content type that is associated to this custom form. The following values are supported: `TEXTBOX`, `QUESTION`.	TEXTBOX, QUESTION
fields	ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_Questionnaires_FieldReference	true	The fields for this specific content.	-
position	integer(int32)	true	The position in which this content will be displayed on the form.	-

ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_Questionnaires_FieldReference

Name	Type	Required	Description	Accepted Values
text	string	true	The text for this specific textbox content. This field should only be specified if the content type is TEXTBOX.	-
label	string	true	The label for this question. This field should only be specified if the content type is QUESTION.	-
isRequired	boolean	true	Whether this question is required. This field should only be specified if the content type is QUESTION.	-
isPatientViewableScore	boolean	true	Whether this question is patient viewable. This field should only be specified if the content type is QUESTION.	-
dta	ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_Questionnaires_DtaReference	true	The DTA reference for this specific content. This field should only be specified if the content type is QUESTION.	-

ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_Questionnaires_DtaReference

Name	Type	Required	Description	Accepted Values
id	string	true	The DTA ID of this question. This field should only be specified if the content type is QUESTION.	-
type	string	true	The DTA type for this question. This field should only be specified if the content type is QUESTION.	-
eventCode	string	true	The event code for this question. This field should only be specified if the content type is QUESTION.	-
referenceRange	ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_Questionnaires_ReferenceRange	false	The reference range for this question. This field should only be specified if the content type is QUESTION and the DTA type is not TEXT or FREE_TEXT.	-
dataMap	ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_Questionnaires_DataMap	false	The data map for this question. This field should only be specified if the content type is QUESTION and the DTA type is NUMERIC.	-
choices	[ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_Questionnaires_Choice]	false	The array of possible choices the patient can select from. This field should only be specified if the content type is QUESTION and the DTA type is ALPHA, MULTI, ALPHA_AND_FREE_TEXT, or MULTI_ALPHA_AND_FREE_TEXT.	-

ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_Questionnaires_ReferenceRange

Name	Type	Required	Description	Accepted Values
feasibleLow	string	false	The low value of the reference range.	-
feasibleHigh	string	false	The high value of the reference range.	-
unit	ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_Questionnaires_Unit	false	The units used for the reference range.	-

ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_Questionnaires_Unit

Name	Type	Required	Description	Accepted Values
value	integer(int32)	false	The unit value.	-
display	string	false	The display name of the unit.	-
meaning	string	false	The meaning of the unit.	-

ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_Questionnaires_DataMap

Name	Type	Required	Description	Accepted Values
minDigits	integer(int32)	false	The minimum number of digits.	-
maxDigits	integer(int32)	false	The maximum number of digits.	-
maxDecimals	integer(int32)	false	The maximum number of decimal places.	-

ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_Questionnaires_Choice

Name	Type	Required	Description	Accepted Values
nomenclatureId	string	false	The ID of the choice.	-
description	string	false	The description of the choice.	-
sequence	integer(int32)	false	The sequence this choice should be displayed in.	-
isDefault	boolean	false	Whether this choice is the default choice.	-
isActive	boolean	false	Whether this choice is active or not.	-
resultValue	string	false	The numeric value assigned to this choice.	-

ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_Questionnaires_QuestionnaireResponse

Name	Type	Required	Description	Accepted Values
responses	[ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_Questionnaires_QuestionResponse]	true	The responses submitted for the questions on this questionnaire.	-

ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_Questionnaires_QuestionResponse

Name	Type	Required	Description	Accepted Values
questionId	string	true	The ID of the question that this response belongs to.	-
answer	ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_Questionnaires_Answer	true	The answer submitted by the patient for this question.	-
createdAt	string	true	The date and time when the question response was created.	-
createdById	string	true	The ID of the user who created the question response.	-
updatedAt	string	true	The date and time when the question response was last updated.	-
updatedById	string	true	The ID of the user who last updated the question response.	-

ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_Questionnaires_Answer

Name	Type	Required	Description	Accepted Values
value	string	false	The value submitted for this answer. This is accepted for the following question types only: DATE, NUMERIC, TEXT, FREE_TEXT, ALPHA_AND_FREE_TEXT, MULTI_ALPHA_AND_FREE_TEXT. For ALPHA_AND_FREE_TEXT, this cannot be specified if selectedChoices is specified.	-
selectedChoices	[ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_Questionnaires_SelectedChoice]	false	The choices selected for this answer. This is accepted for the following question types only: ALPHA, ALPHA_AND_FREE_TEXT, MULTI, MULTI_ALPHA_AND_FREE_TEXT. The ALPHA_AND_FREE_TEXT question type cannot be specified if a value is specified.	-

ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_Questionnaires_SelectedChoice

Name	Type	Required	Description	Accepted Values
nomenclatureId	string	false	The ID of the selected choice.	-

putPatientsPatientidClipboardsClipboardidSectionsSectionidFormsFormidItems

Name	Type	Required	Description	Accepted Values
allergy	object	false	Information related to an allergy item.	-
» comments	string	false	Patient-entered comments regarding the item.	-
» source	string	true	The item type. The following values are supported: `EMR`, `PATIENT`.	EMR, PATIENT
» status	string	true	The item status. If the source is PATIENT the following values are supported: `ADD`.If the source is EMR the following values are supported: `UPDATE`, `KEEP`, `DELETE`.	UPDATE, KEEP, DELETE, ADD
» reactions	[object]	false	An array of reactions associated with an allergy item. Existing reactions can not be updated. For delete existing reaction: do not provide it in array. For keep existing reaction: `id` is required. For create new reaction: `name` is required.	-
»» id	string	false	The ID of the allergic reaction.	-
»» name	string	true	The name of the reaction.	-
»» nomenclatureId	string	false	The nomenclature ID of the reaction.	-
procedure	object	false	Information related to a procedure item.	-
» comments	string	false	Patient-entered comments regarding the item.	-
» source	string	true	The item type. The following values are supported: `EMR`, `PATIENT`.	EMR, PATIENT
» status	string	true	The item status. If the source is PATIENT the following values are supported: `ADD`.If the source is EMR the following values are supported: `UPDATE`.	UPDATE, ADD
» approximateDate	string	false	The approximate date when the procedure was performed. Available formats: YYYY, YYYY-MM, YYYY-MM-DD	-
medication	object	false	Information related to a medication item.	-
» comments	string	false	Patient-entered comments regarding the item.	-
» source	string	true	The item type. The following values are supported: `EMR`, `PATIENT`.	EMR, PATIENT
» status	string	true	The item status. If the source is PATIENT the following values are supported: `ADD`.If the source is EMR the following values are supported: `UPDATE`.	UPDATE, ADD
» dose	string	false	The dose of the medication.	-
» frequency	string	false	Frequency of the medication.	-
» prescribingProvider	string	false	Provider who prescribed the medication.	-
» userStatus	string	false	The user status. The following values are supported: `NOT_SURE`, `AS_PRESCRIBED`, `NOT_TAKING`, `NOT_AS_PRESCRIBED`.	-
» userStatusLabel	string	false	The user status label.	-
immunization	object	false	Information related to a medication item.	-
» comments	string	false	Patient-entered comments regarding the item.	-
» source	string	true	The item type. The following values are supported: `PATIENT`.	PATIENT
» status	string	true	The item status. If the source is PATIENT the following values are supported: `ADD`.	ADD
» approximateDate	string	false	Approximate date the immunization was received. Available formats: YYYY, YYYY-MM, YYYY-MM-DD	-

ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_FormItems_FullUpdateItemEntity

Name	Type	Required	Description	Accepted Values
allergy	ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_FormItems_AllergyUpdateItem	false	Information related to an allergy item.	-
medication	ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_FormItems_MedicationUpdateItem	false	Information related to a medication item.	-
immunization	ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_FormItems_ImmunizationUpdateItem	false	Information related to an immunization item.	-
procedure	ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_FormItems_ProcedureUpdateItem	false	Information related to a procedure item.	-

ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_FormItems_AllergyUpdateItem

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the EMR or patient-entered item.	-
name	string	true	The name of the item.	-
comments	string	false	Patient-entered comments regarding the item.	-
createdAt	string	true	The date and time when the item was created.	-
updatedAt	string	true	The date and time when the item was updated.	-
source	string	true	The item type. The following values are supported: `EMR`, `PATIENT`.	EMR, PATIENT
status	string	true	The item status. If the source is PATIENT the following values are supported: `ADD`.If the source is EMR the following values are supported: `UPDATE`, `KEEP`, `DELETE`.	UPDATE, KEEP, DELETE, ADD
nomenclatureId	string	false	The nomenclature ID of the allergy.	-
reactions	[ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_FormItems_Reaction]	false	An array of reactions associated with an allergy item.	-

ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_FormItems_MedicationUpdateItem

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the EMR or patient-entered item.	-
name	string	true	The name of the item.	-
comments	string	false	Patient-entered comments regarding the item.	-
createdAt	string	true	The date and time when the item was created.	-
updatedAt	string	true	The date and time when the item was updated.	-
source	string	true	The item type. The following values are supported: `EMR`, `PATIENT`.	EMR, PATIENT
status	string	true	The item status. If the source is PATIENT the following values are supported: `ADD`.If the source is EMR the following values are supported: `UPDATE`.	UPDATE, ADD
synonymId	string	false	The synonym ID of the medication.	-
dose	string	false	The dose of the medication.	-
frequency	string	false	Frequency of the medication.	-
prescribingProvider	string	false	Provider who prescribed the medication.	-
userStatus	string	true	The user status. The following values are supported: `NOT_SURE`, `AS_PRESCRIBED`, `NOT_TAKING`, `NOT_AS_PRESCRIBED`.	-
userStatusLabel	string	true	The user status label.	-

ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_FormItems_ImmunizationUpdateItem

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the EMR or patient-entered item.	-
name	string	true	The name of the item.	-
comments	string	false	Patient-entered comments regarding the item.	-
createdAt	string	true	The date and time when the item was created.	-
updatedAt	string	true	The date and time when the item was updated.	-
source	string	true	The item type. The following values are supported: `PATIENT`.	PATIENT
status	string	true	The item status. If the source is PATIENT the following values are supported: `ADD`.	ADD
eventCode	string	false	The event code of the immunization.	-
approximateDate	string	true	Approximate date the immunization was received. Available formats: YYYY, YYYY-MM, YYYY-MM-DD	-

ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_FormItems_ProcedureUpdateItem

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the EMR or patient-entered item.	-
name	string	true	The name of the item.	-
comments	string	false	Patient-entered comments regarding the item.	-
createdAt	string	true	The date and time when the item was created.	-
updatedAt	string	true	The date and time when the item was updated.	-
source	string	true	The item type. The following values are supported: `EMR`, `PATIENT`.	EMR, PATIENT
status	string	true	The item status. If the source is PATIENT the following values are supported: `ADD`.If the source is EMR the following values are supported: `UPDATE`.	UPDATE, ADD
approximateDate	string	false	The approximate date when the procedure was performed. Available formats: YYYY, YYYY-MM, YYYY-MM-DD	-
nomenclatureId	string	false	The nomenclature ID of the procedure.	-

postPatientsPatientidClipboardsClipboardidSectionsSectionidFormsFormidItems

Name	Type	Required	Description	Accepted Values
allergy	object	false	Information related to an allergy item.	-
» name	string	true	The name of the item.	-
» comments	string	false	Patient-entered comments regarding the item.	-
» nomenclatureId	string	false	The nomenclature ID of the allergy.	-
» reactions	[object]	false	An array of reactions associated with an allergy item.	-
»» name	string	true	The name of the reaction.	-
»» nomenclatureId	string	false	The nomenclature ID of the reaction.	-
procedure	object	false	Information related to a procedure item.	-
» name	string	true	The name of the item.	-
» comments	string	false	Patient-entered comments regarding the item.	-
» nomenclatureId	string	false	The nomenclature ID of the procedure.	-
» approximateDate	string	false	The approximate date when the procedure was performed. Available formats: YYYY, YYYY-MM, YYYY-MM-DD	-
medication	object	false	Information related to a medication item.	-
» name	string	true	The name of the item.	-
» comments	string	false	Patient-entered comments regarding the item.	-
» synonymId	string	false	The synonym ID of the medication.	-
» dose	string	false	The dose of the medication.	-
» frequency	string	false	Frequency of the medication.	-
» prescribingProvider	string	false	Provider who prescribed the medication.	-
» userStatus	string	true	The user status. The following values are supported: `NOT_SURE`, `AS_PRESCRIBED`, `NOT_TAKING`, `NOT_AS_PRESCRIBED`.	-
» userStatusLabel	string	true	The user status label.	-
immunization	object	false	Information related to an immunization item.	-
» name	string	true	The name of the item.	-
» comments	string	false	Patient-entered comments regarding the item.	-
» eventCode	string	false	The event code of the immunization.	-
» approximateDate	string	true	Approximate date the immunization was received. Available formats: YYYY, YYYY-MM, YYYY-MM-DD	-

ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_FormItems_FullItemPatientEntered

Name	Type	Required	Description	Accepted Values
allergy	ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_FormItems_AllergyItemPatientEntered	false	Information related to an allergy item.	-
procedure	ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_FormItems_ProcedureItemPatientEntered	false	Information related to a procedure item.	-
medication	ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_FormItems_MedicationItemPatientEntered	false	Information related to a medication item.	-
immunization	ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_FormItems_ImmunizationItemPatientEntered	false	Information related to an immunization item.	-

ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_FormItems_AllergyItemPatientEntered

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the EMR or patient-entered item.	-
name	string	true	The name of the item.	-
comments	string	false	Patient-entered comments regarding the item.	-
createdAt	string	true	The date and time when the item was created.	-
updatedAt	string	true	The date and time when the item was updated.	-
source	string	true	The item source. The source value is always PATIENT because only patient-entered items can be created through this endpoint.	PATIENT
status	string	true	The item status. The status value is always ADD because items can only be created through this endpoint.	ADD
nomenclatureId	string	false	The nomenclature ID of the allergy.	-
reactions	[ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_FormItems_Reaction]	false	An array of reactions associated with an allergy item.	-

ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_FormItems_ProcedureItemPatientEntered

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the EMR or patient-entered item.	-
name	string	true	The name of the item.	-
comments	string	false	Patient-entered comments regarding the item.	-
createdAt	string	true	The date and time when the item was created.	-
updatedAt	string	true	The date and time when the item was updated.	-
source	string	true	The item source. The source value is always PATIENT because only patient-entered items can be created through this endpoint.	PATIENT
status	string	true	The item status. The status value is always ADD because items can only be created through this endpoint.	ADD
approximateDate	string	false	The approximate date when the procedure was performed. Available formats: YYYY, YYYY-MM, YYYY-MM-DD	-
nomenclatureId	string	false	The nomenclature ID of the procedure.	-

ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_FormItems_MedicationItemPatientEntered

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the EMR or patient-entered item.	-
name	string	true	The name of the item.	-
comments	string	false	Patient-entered comments regarding the item.	-
createdAt	string	true	The date and time when the item was created.	-
updatedAt	string	true	The date and time when the item was updated.	-
source	string	true	The item source. The source value is always PATIENT because only patient-entered items can be created through this endpoint.	PATIENT
status	string	true	The item status. The status value is always ADD because items can only be created through this endpoint.	ADD
synonymId	string	false	The synonym ID of the medication.	-
dose	string	false	The dose of the medication.	-
frequency	string	false	Frequency of the medication.	-
prescribingProvider	string	false	Provider who prescribed the medication.	-
userStatus	string	true	The user status. The following values are supported: `NOT_SURE`, `AS_PRESCRIBED`, `NOT_TAKING`, `NOT_AS_PRESCRIBED`.	-
userStatusLabel	string	true	The user status label.	-

ConsumerEngagementPublicApi_Entities_V1_PatientClipboards_FormItems_ImmunizationItemPatientEntered

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the EMR or patient-entered item.	-
name	string	true	The name of the item.	-
comments	string	false	Patient-entered comments regarding the item.	-
createdAt	string	true	The date and time when the item was created.	-
updatedAt	string	true	The date and time when the item was updated.	-
source	string	true	The item source. The source value is always PATIENT because only patient-entered items can be created through this endpoint.	PATIENT
status	string	true	The item status. The status value is always ADD because items can only be created through this endpoint.	ADD
eventCode	string	false	The event code of the immunization.	-
approximateDate	string	true	Approximate date the immunization was received. Available formats: YYYY, YYYY-MM, YYYY-MM-DD	-