The Oracle Health Data Intelligence Consumer Notification API allows you to contact consumers
about notifiable events related to their health or medical care, for example,
notifications about available bills, updates to electronic health
records (EHRs), or new messages from clinicians. The Notifiable Events endpoints allow you to manage the
list of events for which a consumer can be notified, and the Notifications endpoint allows you to create
a notification for a notifiable event. The API currently can be used to send notifications to consumers using
email, mobile push notifications, and short message service (SMS). Consumers can elect to receive or not to
receive notifications based on the type of notifiable event and the delivery mechanism.
A notification is a message sent to a consumer to inform them that an event has
occurred. The message can be sent using multiple delivery mechanisms. Currently, the API supports
the email, push notification, and SMS delivery mechanisms.
Send a Notification to a Consumer
Example Request:
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Content-Type'=>'application/json','Accept'=>'application/json'}result=HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/notifiable-events/a1201faa-8258-4815-a516-6b43ce07d1f3/notifications',headers: headers,body: {"emailSubject":"John, a new lab result is ready to view.","emailHTML":"<!DOCTYPE html>\n<html lang=\"en\">\n<head>\n<meta charset=\"utf-8\" />\n</head>\n<body>\n<p>Hi John,</p>\n<p>A lab result for Jane Smith is now available for you to view. Visit www.cerner.com to review this information.</p>\n<p>Notes: Because protecting the privacy of your health information is important to us, we have made this process extremely secure. The email provided to you should be kept confidential. Do not reply to this message, as it was sent from an unmonitored email inbox.</p>\n</body>\n</html>","emailPlainText":"Hi John,\n A lab result for Jane Smith is now available for you to view. Visit www.cerner.com to review this information. \\n Notes: Because protecting the privacy of your health information is important to us,' 'we have made this process extremely secure. The email provided to youshould be kept confidential. Do not reply to this message, as it was sent from an unmonitored email inbox.","pushSubject":"Lab Result","pushBody":"A new lab result is available to view.","smsBody":"A new lab result is ready to view at www.cerner.com. View your profile to edit your message settings.","consumer":{"id":"90baba1a-8bde-4a93-aed1-feb56f333039"}}.to_json)printJSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/notifiable-events/a1201faa-8258-4815-a516-6b43ce07d1f3/notifications \-H'Authorization: {auth_header}'\-H'Content-Type: application/json'\ \-H'Accept: application/json'\-d{"emailSubject":"John, a new lab result is ready to view.","emailHTML":"<!DOCTYPE html>\n<html lang=\"en\">\n<head>\n<meta charset=\"utf-8\" />\n</head>\n<body>\n<p>Hi John,</p>\n<p>A lab result for Jane Smith is now available for you to view. Visit www.cerner.com to review this information.</p>\n<p>Notes: Because protecting the privacy of your health information is important to us, we have made this process extremely secure. The email provided to you should be kept confidential. Do not reply to this message, as it was sent from an unmonitored email inbox.</p>\n</body>\n</html>","emailPlainText":"Hi John,\n A lab result for Jane Smith is now available for you to view. Visit www.cerner.com to review this information. \\n Notes: Because protecting the privacy of your health information is important to us,' 'we have made this process extremely secure. The email provided to youshould be kept confidential. Do not reply to this message, as it was sent from an unmonitored email inbox.","pushSubject":"Lab Result","pushBody":"A new lab result is available to view.","smsBody":"A new lab result is ready to view at www.cerner.com. View your profile to edit your message settings.","consumer":{"id":"90baba1a-8bde-4a93-aed1-feb56f333039"}}
POST /notifiable-events/{notifiableEventId}/notifications
Sends a notification to the consumer as an email, mobile push notification, or SMS.
The API can send the same notification to the consumer using multiple delivery mechanisms.
The following mechanisms are available:
Email: Email notifications are sent to the consumer’s first email address.
Push: Push notifications are sent by the HealtheLife mobile app.
SMS: SMS notifications are sent to the consumer’s first phone number.
This endpoint retrieves the consumer’s first email address and phone number from the
Consumer API.
Cerner does not recommend using this endpoint to manage a consumer’s email address and phone number;
instead, the consumer can manage their own contact information using the HealtheLife application.
If no email address or phone number exists, no notification is sent by that delivery mechanism. The
consumer must opt in to receive notifications for a notifiable event by setting their consumer
notification preferences for each delivery mechanism.
Note: SMS notification messages should be less than 114 characters; if the message is greater
than 114 characters, the message is sent as multiple messages to the consumer.
Notifiable events are events that consumers may want to be notified of, for example, an
available bill, an update to their EHR, or a new message.
Create a Notifiable Event
Example Request:
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Content-Type'=>'application/json','Accept'=>'application/json'}result=HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/notifiable-events',headers: headers,body: {"name":"Secure Message","translations":[{"locale":"en-US","displayName":"Radiology Report","description":"Sign up to receive the latest news related to the wellness program."}]}.to_json)printJSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/notifiable-events \-H'Authorization: {auth_header}'\-H'Content-Type: application/json'\ \-H'Accept: application/json'\-d{"name":"Secure Message","translations":[{"locale":"en-US","displayName":"Radiology Report","description":"Sign up to receive the latest news related to the wellness program."}]}
POST /notifiable-events
Creates a notifiable event and one or more translations associated with the notifiable event.
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/notifiable-events',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/notifiable-events \-H'Authorization: {auth_header}'\-H'Accept: application/json'
Example response
{"items":[{"id":"91682e64-f541-45bf-a892-64725461fdcc","name":"Secure Message","translations":[{"locale":"en-US","displayName":"Radiology Report","description":"Sign up to receive the latest news related to the wellness program."}],"createdAt":"2018-05-15T12:23:12Z","updatedAt":"2018-05-15T12:23:12Z"}],"totalResults":1,"firstLink":"https://cernerdemo.api.us-1.healtheintent.com/api/v1/consumer-notifications/notifiable-events?offset=0&limit=20","lastLink":"https://cernerdemo.api.us-1.healtheintent.com/api/v1/consumer-notifications/notifiable-events?offset=0&limit=20"}
GET /notifiable-events
Retrieves a list of the different types of events for which notifications can be sent.
Parameters
Parameter
In
Type
Required
Default
Description
Accepted Values
locale
query
string
false
N/A
Retrieves only the notification event’s translation for the specified locale, if it exists.
-
name
query
string
false
N/A
Retrieves the notifiable event with the exactly matching name.
-
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.
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/notifiable-events/a1201faa-8258-4815-a516-6b43ce07d1f3',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/notifiable-events/a1201faa-8258-4815-a516-6b43ce07d1f3 \-H'Authorization: {auth_header}'\-H'Accept: application/json'
DELETE /notifiable-events/{notifiableEventId}
Removes a single notifiable event and its translations from the system.
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Content-Type'=>'application/json','Accept'=>'application/json'}result=HTTParty.patch('https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/notifiable-events/a1201faa-8258-4815-a516-6b43ce07d1f3',headers: headers,body: {"name":"Secure Message","translations":[{"locale":"en-US","displayName":"Radiology Report","description":"Sign up to receive the latest news related to the wellness program."}]}.to_json)printJSON.pretty_generate(result)
# You can also use wget
curl -X PATCH https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/notifiable-events/a1201faa-8258-4815-a516-6b43ce07d1f3 \-H'Authorization: {auth_header}'\-H'Content-Type: application/json'\ \-H'Accept: application/json'\-d{"name":"Secure Message","translations":[{"locale":"en-US","displayName":"Radiology Report","description":"Sign up to receive the latest news related to the wellness program."}]}
PATCH /notifiable-events/{notifiableEventId}
Updates the name or translations of a notifiable event. The update behavior follows the
RFC 7396 JSON Merge Patch standard on the Internet Engineering Task Force (IETF) website.
Note: The link above is to an external resource. This resource is provided for reference purposes and should be used with caution.
Contact your Cerner support team for more information about third-party content.
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/notifiable-events/a1201faa-8258-4815-a516-6b43ce07d1f3',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/notifiable-events/a1201faa-8258-4815-a516-6b43ce07d1f3 \-H'Authorization: {auth_header}'\-H'Accept: application/json'
Example response
{"id":"91682e64-f541-45bf-a892-64725461fdcc","name":"Secure Message","translations":[{"locale":"en-US","displayName":"Radiology Report","description":"Sign up to receive the latest news related to the wellness program."}],"createdAt":"2018-05-15T12:23:12Z","updatedAt":"2018-05-15T12:23:12Z"}
GET /notifiable-events/{notifiableEventId}
Retrieves the information for a single notifiable event by ID.
Parameters
Parameter
In
Type
Required
Default
Description
Accepted Values
notifiableEventId
path
string
true
N/A
The ID of the notifiable event.
-
locale
query
string
false
N/A
Retrieves only the notification event’s translation for the specified locale, if it exists.
Consumers can set preferences to determine how they want to be notified. A consumer preference
specifies which notifiable events the consumer wants to be notified about and which delivery mechanisms
they want to be used to notify them about those events, if any. For example, a consumer might prefer to be notified
about EHR updates by SMS and push notifications but prefer to be notified about new
messages by only email. When sending a notification for a notifiable event, the API checks the consumer preference
for the type of event. The API then attempts to send a notification using every delivery
mechanism through which the consumer has chosen to receive notifications. If the consumer has
selected false for all the delivery mechanisms, no notification is sent.
Delete a Consumer Notification Preference
Example Request:
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/consumers/{consumerId}/preferences/{preferenceId}',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/consumers/{consumerId}/preferences/{preferenceId}\-H'Authorization: {auth_header}'\-H'Accept: application/json'
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Content-Type'=>'application/json','Accept'=>'application/json'}result=HTTParty.patch('https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/consumers/{consumerId}/preferences/{preferenceId}',headers: headers,body: {"desiresEmail":true,"desiresSms":true,"desiresPush":true}.to_json)printJSON.pretty_generate(result)
# You can also use wget
curl -X PATCH https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/consumers/{consumerId}/preferences/{preferenceId}\-H'Authorization: {auth_header}'\-H'Content-Type: application/json'\ \-H'Accept: application/json'\-d{"desiresEmail":true,"desiresSms":true,"desiresPush":true}
Updates a consumer’s notification preference using the specified body parameters
and the consumer’s notification preference ID. The update behavior follows the
RFC 7396 JSON Merge Patch standard on the IETF website.
Note: The link above is to an external resource. This resource is provided for reference purposes and should be used with caution.
Contact your Cerner support team for more information about third-party content.
Retrieve a Single Consumer Notification Preference
Example Request:
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/consumers/{consumerId}/preferences/{preferenceId}',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/consumers/{consumerId}/preferences/{preferenceId}\-H'Authorization: {auth_header}'\-H'Accept: application/json'
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Content-Type'=>'application/json','Accept'=>'application/json'}result=HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/consumers/{consumerId}/preferences',headers: headers,body: {"desiresEmail":true,"desiresSms":true,"desiresPush":true,"notifiableEvent":{"id":"5ecaf544-01d5-01kf-95hj-8e2bcec12006"}}.to_json)printJSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/consumers/{consumerId}/preferences \-H'Authorization: {auth_header}'\-H'Content-Type: application/json'\ \-H'Accept: application/json'\-d{"desiresEmail":true,"desiresSms":true,"desiresPush":true,"notifiableEvent":{"id":"5ecaf544-01d5-01kf-95hj-8e2bcec12006"}}
POST /consumers/{consumerId}/preferences
Creates a consumer notification preference with the specified body parameters.
Retrieve a List of Consumer Notification Preferences
Example Request:
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/consumers/{consumerId}/preferences',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/consumers/{consumerId}/preferences \-H'Authorization: {auth_header}'\-H'Accept: application/json'
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Content-Type'=>'application/json','Accept'=>'application/json'}result=HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/notification-content',headers: headers,body: {"locale":"en-US","notificationType":"RADIOLOGY","emailSubject":"{{user_first_name}} a new document is ready to view.","emailContentHtml":"<!DOCTYPE html>\\n<html lang=\\\"en\\\">\\n <head>\\n <meta charset=\\\"utf-8\\\" />\\n <p>Hi {{user_first_name}},</p>\\n <p> a clinical note for {{person_first_name}} has been added.</p>\\n","emailContentPlaintext":"Hi {{user_first_name}},\n a clinical notte for {{person_first_name}} has been added.\n","smsContent":"A new radiology report is ready to view {{url}}.View your profile to edit message settings.","mobilePushSubject":"Radiology Report.","mobilePushContent":"A new radiology report is ready to view.","applicationExperienceDomain":"https://cernerdemo.wellness.us.healtheintent.com"}.to_json)printJSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/notification-content \-H'Authorization: {auth_header}'\-H'Content-Type: application/json'\ \-H'Accept: application/json'\-d{"locale":"en-US","notificationType":"RADIOLOGY","emailSubject":"{{user_first_name}} a new document is ready to view.","emailContentHtml":"<!DOCTYPE html>\\n<html lang=\\\"en\\\">\\n <head>\\n <meta charset=\\\"utf-8\\\" />\\n <p>Hi {{user_first_name}},</p>\\n <p> a clinical note for {{person_first_name}} has been added.</p>\\n","emailContentPlaintext":"Hi {{user_first_name}},\n a clinical notte for {{person_first_name}} has been added.\n","smsContent":"A new radiology report is ready to view {{url}}.View your profile to edit message settings.","mobilePushSubject":"Radiology Report.","mobilePushContent":"A new radiology report is ready to view.","applicationExperienceDomain":"https://cernerdemo.wellness.us.healtheintent.com"}
Example response
{"id":"91682e64-f541-45bf-a892-64725461fdcc","locale":"en-US","notificationType":"RADIOLOGY","emailSubject":"{{user_first_name}} a new document is ready to view.","emailContentHtml":"<!DOCTYPE html>\\n<html lang=\\\"en\\\">\\n <head>\\n <meta charset=\\\"utf-8\\\" />\\n <p>Hi {{user_first_name}},</p>\\n <p> a clinical note for {{person_first_name}} has been added.</p>\\n","emailContentPlaintext":"Hi {{user_first_name}},\n a clinical notte for {{person_first_name}} has been added.\n","smsContent":"A new radiology report is ready to view {{url}}.View your profile to edit message settings.","mobilePushSubject":"Radiology Report.","mobilePushContent":"A new radiology report is ready to view.","applicationExperienceDomain":"https://cernerdemo.wellness.us.healtheintent.com","createdAt":"2021-04-19T13:33:42.859Z"}
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/notification-content',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/notification-content \-H'Authorization: {auth_header}'\-H'Accept: application/json'
Example response
{"items":[{"id":"91682e64-f541-45bf-a892-64725461fdcc","locale":"en-US","notificationType":"RADIOLOGY","emailSubject":"{{user_first_name}} a new document is ready to view.","emailContentHtml":"<!DOCTYPE html>\\n<html lang=\\\"en\\\">\\n <head>\\n <meta charset=\\\"utf-8\\\" />\\n <p>Hi {{user_first_name}},</p>\\n <p> a clinical note for {{person_first_name}} has been added.</p>\\n","emailContentPlaintext":"Hi {{user_first_name}},\n a clinical notte for {{person_first_name}} has been added.\n","smsContent":"A new radiology report is ready to view {{url}}.View your profile to edit message settings.","mobilePushSubject":"Radiology Report.","mobilePushContent":"A new radiology report is ready to view.","applicationExperienceDomain":"https://cernerdemo.wellness.us.healtheintent.com","createdAt":"2021-04-19T13:33:42.859Z"}],"totalResults":1,"firstLink":"https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/notification-content?offset=0&limit=20","lastLink":"https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/notification-content?offset=0&limit=20"}
GET /notification-content
Retrieves a list of all Notification Contents.
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.
-
locale
query
string
false
N/A
The locale of the content.
-
notificationType
query
string
false
N/A
The notification type for which the content is created.
-
applicationExperienceDomain
query
string
false
N/A
The domain name of a tenant in the consumer notifications application.
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/notification-content/16008bea-22ab-468a-8d27-2ed1edf9272a',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/notification-content/16008bea-22ab-468a-8d27-2ed1edf9272a \-H'Authorization: {auth_header}'\-H'Accept: application/json'
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Content-Type'=>'application/json','Accept'=>'application/json'}result=HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/notification-content/16008bea-22ab-468a-8d27-2ed1edf9272a',headers: headers,body: {"locale":"en-US","notificationType":"RADIOLOGY","emailSubject":"{{user_first_name}} a new document is ready to view.","emailContentHtml":"<!DOCTYPE html>\\n<html lang=\\\"en\\\">\\n <head>\\n <meta charset=\\\"utf-8\\\" />\\n <p>Hi {{user_first_name}},</p>\\n <p> a clinical note for {{person_first_name}} has been added.</p>\\n","emailContentPlaintext":"Hi {{user_first_name}},\n a clinical notte for {{person_first_name}} has been added.\n","smsContent":"A new radiology report is ready to view {{url}}.View your profile to edit message settings.","mobilePushSubject":"Radiology Report.","mobilePushContent":"A new radiology report is ready to view.","applicationExperienceDomain":"https://cernerdemo.wellness.us.healtheintent.com"}.to_json)printJSON.pretty_generate(result)
# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/notification-content/16008bea-22ab-468a-8d27-2ed1edf9272a \-H'Authorization: {auth_header}'\-H'Content-Type: application/json'\ \-H'Accept: application/json'\-d{"locale":"en-US","notificationType":"RADIOLOGY","emailSubject":"{{user_first_name}} a new document is ready to view.","emailContentHtml":"<!DOCTYPE html>\\n<html lang=\\\"en\\\">\\n <head>\\n <meta charset=\\\"utf-8\\\" />\\n <p>Hi {{user_first_name}},</p>\\n <p> a clinical note for {{person_first_name}} has been added.</p>\\n","emailContentPlaintext":"Hi {{user_first_name}},\n a clinical notte for {{person_first_name}} has been added.\n","smsContent":"A new radiology report is ready to view {{url}}.View your profile to edit message settings.","mobilePushSubject":"Radiology Report.","mobilePushContent":"A new radiology report is ready to view.","applicationExperienceDomain":"https://cernerdemo.wellness.us.healtheintent.com"}
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/notification-content/16008bea-22ab-468a-8d27-2ed1edf9272a',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/notification-content/16008bea-22ab-468a-8d27-2ed1edf9272a \-H'Authorization: {auth_header}'\-H'Accept: application/json'
Example response
{"id":"91682e64-f541-45bf-a892-64725461fdcc","locale":"en-US","notificationType":"RADIOLOGY","emailSubject":"{{user_first_name}} a new document is ready to view.","emailContentHtml":"<!DOCTYPE html>\\n<html lang=\\\"en\\\">\\n <head>\\n <meta charset=\\\"utf-8\\\" />\\n <p>Hi {{user_first_name}},</p>\\n <p> a clinical note for {{person_first_name}} has been added.</p>\\n","emailContentPlaintext":"Hi {{user_first_name}},\n a clinical notte for {{person_first_name}} has been added.\n","smsContent":"A new radiology report is ready to view {{url}}.View your profile to edit message settings.","mobilePushSubject":"Radiology Report.","mobilePushContent":"A new radiology report is ready to view.","applicationExperienceDomain":"https://cernerdemo.wellness.us.healtheintent.com","createdAt":"2021-04-19T13:33:42.859Z"}
GET /notification-content/{notificationContentId}
Retrieves the information for a single Notification Content by ID.
Retrieve a List of Default Notification Content template
Example Request:
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/notification-content-templates',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/notification-content-templates \-H'Authorization: {auth_header}'\-H'Accept: application/json'
Example response
{"items":[{"id":"91682e64-f541-45bf-a892-64725461fdcc","locale":"en-US","notificationType":"RADIOLOGY","emailSubject":"{{user_first_name}} a new document is ready to view.","emailContentHtml":"<!DOCTYPE html>\\n<html lang=\\\"en\\\">\\n <head>\\n <meta charset=\\\"utf-8\\\" />\\n <p>Hi {{user_first_name}},</p>\\n <p> a clinical note for {{person_first_name}} has been added.</p>\\n","emailContentPlaintext":"Hi {{user_first_name}},\n a clinical notte for {{person_first_name}} has been added.\n","smsContent":"A new radiology report is ready to view {{url}}.View your profile to edit message settings.","mobilePushSubject":"Radiology Report.","mobilePushContent":"A new radiology report is ready to view.","createdAt":"2021-04-19T13:33:42.859Z"}],"totalResults":1,"firstLink":"https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/notification-content-templates?offset=0&limit=20","lastLink":"https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/notification-content-templates?offset=0&limit=20"}
GET /notification-content-templates
Retrieves a list of Notification Content Templates for all the locales and notification types. It can be filtered for a specific locale and/ or notification type.
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.
-
locale
query
string
false
N/A
The locale of the content.
-
notificationType
query
string
false
N/A
The notification type for which the content is created.
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Content-Type'=>'application/json','Accept'=>'application/json'}result=HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/email-configs',headers: headers,body: {"fromName":"Baker","fromEmail":"Baker@cerner.com","replyToEmail":"Baker@cerner.com","returnPath":"Baker@cerner.com","applicationExperienceDomain":"dev.healtheintent.com"}.to_json)printJSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/email-configs \-H'Authorization: {auth_header}'\-H'Content-Type: application/json'\ \-H'Accept: application/json'\-d{"fromName":"Baker","fromEmail":"Baker@cerner.com","replyToEmail":"Baker@cerner.com","returnPath":"Baker@cerner.com","applicationExperienceDomain":"dev.healtheintent.com"}
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/email-configs',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/email-configs \-H'Authorization: {auth_header}'\-H'Accept: application/json'
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.
-
applicationExperienceDomain
query
string
false
N/A
The domain name of a tenant in the consumer notifications application.
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/email-configs/99008cbc-d75c-4be2-bdc8-e215d9602a47',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/email-configs/99008cbc-d75c-4be2-bdc8-e215d9602a47 \-H'Authorization: {auth_header}'\-H'Accept: application/json'
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Content-Type'=>'application/json','Accept'=>'application/json'}result=HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/email-configs/99008cbc-d75c-4be2-bdc8-e215d9602a47',headers: headers,body: {"fromName":"Baker","fromEmail":"Baker@cerner.com","replyToEmail":"Baker@cerner.com","returnPath":"Baker@cerner.com","applicationExperienceDomain":"dev.healtheintent.com"}.to_json)printJSON.pretty_generate(result)
# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/email-configs/99008cbc-d75c-4be2-bdc8-e215d9602a47 \-H'Authorization: {auth_header}'\-H'Content-Type: application/json'\ \-H'Accept: application/json'\-d{"fromName":"Baker","fromEmail":"Baker@cerner.com","replyToEmail":"Baker@cerner.com","returnPath":"Baker@cerner.com","applicationExperienceDomain":"dev.healtheintent.com"}
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/email-configs/99008cbc-d75c-4be2-bdc8-e215d9602a47',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/email-configs/99008cbc-d75c-4be2-bdc8-e215d9602a47 \-H'Authorization: {auth_header}'\-H'Accept: application/json'
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Content-Type'=>'application/json','Accept'=>'application/json'}result=HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/sms-configs',headers: headers,body: {"wellEnabled":"true","revcycleEnabled":"true","applicationExperienceDomain":"dev.healtheintent.com"}.to_json)printJSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/sms-configs \-H'Authorization: {auth_header}'\-H'Content-Type: application/json'\ \-H'Accept: application/json'\-d{"wellEnabled":"true","revcycleEnabled":"true","applicationExperienceDomain":"dev.healtheintent.com"}
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/sms-configs',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/sms-configs \-H'Authorization: {auth_header}'\-H'Accept: application/json'
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.
-
applicationExperienceDomain
query
string
false
N/A
The domain name of a tenant in the consumer notifications application.
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/sms-configs/8832798d-2367-4eb2-8a4d-ef18aefe3242',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/sms-configs/8832798d-2367-4eb2-8a4d-ef18aefe3242 \-H'Authorization: {auth_header}'\-H'Accept: application/json'
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Content-Type'=>'application/json','Accept'=>'application/json'}result=HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/sms-configs/8832798d-2367-4eb2-8a4d-ef18aefe3242',headers: headers,body: {"wellEnabled":"true","revcycleEnabled":"true","applicationExperienceDomain":"dev.healtheintent.com"}.to_json)printJSON.pretty_generate(result)
# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/sms-configs/8832798d-2367-4eb2-8a4d-ef18aefe3242 \-H'Authorization: {auth_header}'\-H'Content-Type: application/json'\ \-H'Accept: application/json'\-d{"wellEnabled":"true","revcycleEnabled":"true","applicationExperienceDomain":"dev.healtheintent.com"}
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/sms-configs/8832798d-2367-4eb2-8a4d-ef18aefe3242',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/sms-configs/8832798d-2367-4eb2-8a4d-ef18aefe3242 \-H'Authorization: {auth_header}'\-H'Accept: application/json'
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Content-Type'=>'application/json','Accept'=>'application/json'}result=HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/well-sms-configs',headers: headers,body: {"apiKey":"91682e64-f541-45bf-a892-64725461fdcc","apiSecret":"91682e64-f541-45bf-a892-64725461fdcc","apiUrl":"https://test-url.com","enterpriseId":"91682e64-f541-45bf-a892-64725461fdcc","applicationExperienceDomain":"dev.healtheintent.com","practiceId":"91682e64-f541-45bf-a892-64725461fdcc"}.to_json)printJSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/well-sms-configs \-H'Authorization: {auth_header}'\-H'Content-Type: application/json'\ \-H'Accept: application/json'\-d{"apiKey":"91682e64-f541-45bf-a892-64725461fdcc","apiSecret":"91682e64-f541-45bf-a892-64725461fdcc","apiUrl":"https://test-url.com","enterpriseId":"91682e64-f541-45bf-a892-64725461fdcc","applicationExperienceDomain":"dev.healtheintent.com","practiceId":"91682e64-f541-45bf-a892-64725461fdcc"}
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/well-sms-configs',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/well-sms-configs \-H'Authorization: {auth_header}'\-H'Accept: application/json'
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.
-
applicationExperienceDomain
query
string
false
N/A
The domain name of a tenant in the consumer notifications application.
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/well-sms-configs/ecb5ef28-baea-4afd-ab8d-5ac3c88747fd',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/well-sms-configs/ecb5ef28-baea-4afd-ab8d-5ac3c88747fd \-H'Authorization: {auth_header}'\-H'Accept: application/json'
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Content-Type'=>'application/json','Accept'=>'application/json'}result=HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/well-sms-configs/ecb5ef28-baea-4afd-ab8d-5ac3c88747fd',headers: headers,body: {"apiKey":"91682e64-f541-45bf-a892-64725461fdcc","apiSecret":"91682e64-f541-45bf-a892-64725461fdcc","apiUrl":"https://test-url.com","enterpriseId":"91682e64-f541-45bf-a892-64725461fdcc","applicationExperienceDomain":"dev.healtheintent.com","practiceId":"91682e64-f541-45bf-a892-64725461fdcc"}.to_json)printJSON.pretty_generate(result)
# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/well-sms-configs/ecb5ef28-baea-4afd-ab8d-5ac3c88747fd \-H'Authorization: {auth_header}'\-H'Content-Type: application/json'\ \-H'Accept: application/json'\-d{"apiKey":"91682e64-f541-45bf-a892-64725461fdcc","apiSecret":"91682e64-f541-45bf-a892-64725461fdcc","apiUrl":"https://test-url.com","enterpriseId":"91682e64-f541-45bf-a892-64725461fdcc","applicationExperienceDomain":"dev.healtheintent.com","practiceId":"91682e64-f541-45bf-a892-64725461fdcc"}
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/well-sms-configs/ecb5ef28-baea-4afd-ab8d-5ac3c88747fd',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/well-sms-configs/ecb5ef28-baea-4afd-ab8d-5ac3c88747fd \-H'Authorization: {auth_header}'\-H'Accept: application/json'
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Content-Type'=>'application/json','Accept'=>'application/json'}result=HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/test-well-sms-configs',headers: headers,body: {"phone":"1234567890","applicationExperienceDomain":"dev.healtheintent.com"}.to_json)printJSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/test-well-sms-configs \-H'Authorization: {auth_header}'\-H'Content-Type: application/json'\ \-H'Accept: application/json'\-d{"phone":"1234567890","applicationExperienceDomain":"dev.healtheintent.com"}
The Preference Modal Configuration endpoints determine if the user is a first time user or not. If the user is not a first time user, the modal is not prompted in the patient portal.
Retrieve a list of Preference Modal Configurations
Example Request:
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/consumers/{consumerId}/preference-modal-configurations',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/consumers/{consumerId}/preference-modal-configurations \-H'Authorization: {auth_header}'\-H'Accept: application/json'
GET /consumers/{consumerId}/preference-modal-configurations
Retrieve a list of Preference Modal Configurations
Parameters
Parameter
In
Type
Required
Default
Description
Accepted Values
consumerId
path
string
true
N/A
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.
Creates new instance of Preference Modal Configuration
Example Request:
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Content-Type'=>'application/json','Accept'=>'application/json'}result=HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/consumers/{consumerId}/preference-modal-configurations',headers: headers,body: {"displayModal":"true"}.to_json)printJSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/consumers/{consumerId}/preference-modal-configurations \-H'Authorization: {auth_header}'\-H'Content-Type: application/json'\ \-H'Accept: application/json'\-d{"displayModal":"true"}
Updates specific instance of Preference Modal Configuration
Example Request:
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Content-Type'=>'application/json','Accept'=>'application/json'}result=HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/consumers/{consumerId}/preference-modal-configurations/{preferenceModalConfigId}',headers: headers,body: {"displayModal":"true"}.to_json)printJSON.pretty_generate(result)
# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/consumers/{consumerId}/preference-modal-configurations/{preferenceModalConfigId}\-H'Authorization: {auth_header}'\-H'Content-Type: application/json'\ \-H'Accept: application/json'\-d{"displayModal":"true"}
PUT /consumers/{consumerId}/preference-modal-configurations/{preferenceModalConfigId}
Updates specific instance of Preference Modal Configuration
Deletes specific instance of Preference Modal Configuration
Example Request:
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/consumers/{consumerId}/preference-modal-configurations/{preferenceModalConfigId}',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/consumers/{consumerId}/preference-modal-configurations/{preferenceModalConfigId}\-H'Authorization: {auth_header}'\-H'Accept: application/json'
The human-readable name of the notifiable event. This is used as the display name ifno translation exists in the user’s locale.
-
translations
[object]
true
The translated display name and description of the notifiable event.
-
» locale
string
true
Subtags from the language subtag registry on the Internet Assigned Numbers Authority (IANA) website, formatted according to the RFC 5646 Tags for Identification Languages standard on the IETF website. Note: The links above are to external resources. These resources are provided for reference purposes and should be used with caution. Contact your Cerner support team for more information about third-party content.
-
» displayName
string
true
The translated display name of the notifiable event. When creating a translation for a new locale, this field is required.
-
» description
string
false
The translated text that describes the notifiable event.
Subtags from the language subtag registry on the Internet Assigned Numbers Authority (IANA) website, formatted according to the RFC 5646 Tags for Identification Languages standard on the IETF website. Note: The links above are to external resources. These resources are provided for reference purposes and should be used with caution. Contact your Cerner support team for more information about third-party content.
-
displayName
string
false
The translated display name of the notifiable event. When creating a translation for a new locale, this field is required.
-
description
string
false
The translated text that describes the notifiable event.
-
Error
Name
Type
Required
Description
Accepted Values
code
integer(int32)
true
The HTTP response status code that represents the error.
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.
-
patchNotifiableEvents
Name
Type
Required
Description
Accepted Values
name
string
false
The human-readable name of the notifiable event. This is used as the display name ifno translation exists in the user’s locale.
-
translations
[object]
false
The translated display name and description of the notifiable event.
-
» description
string
false
The translated text that describes the notifiable event.
-
» displayName
string
false
The translated display name of the notifiable event. When creating a translation for a new locale, this field is required.
-
» locale
string
true
Subtags from the language subtag registry on the Internet Assigned Numbers Authority (IANA) website, formatted according to the RFC 5646 Tags for Identification Languages standard on the IETF website. Note: The links above are to external resources. These resources are provided for reference purposes and should be used with caution. Contact your Cerner support team for more information about third-party content.
The subject of the email. This field is required to send email notifications. The maximum length is 889 characters.
-
emailHTML
string
false
The HTML content of the email. Either the {emailHTML} or {emailPlainText} field is required to send email notifications. Both fields can be used in the same request.
-
emailPlainText
string
false
The plain text content of the email. Either the {emailHTML} or {emailPlainText} field is required to send email notifications. Both fields can be used in the same request.
-
pushSubject
string
false
The subject of the mobile push notification. This field is required to send mobile push notifications. The maximum length is 40 characters.
-
pushBody
string
false
The text content of the mobile push notification. This field is required to send mobile push notifications. The maximum length is 1000 characters.
-
smsBody
string
false
The text content of the SMS message. This field is required to send SMS message notifications. The maximum length is 456 characters.
-
consumer
object
true
A JSON object that represents a consumer.
-
» id
string
true
The ID of the consumer.
-
patchConsumersConsumeridPreferences
Name
Type
Required
Description
Accepted Values
desiresEmail
boolean
false
Indicates whether the consumer wants to be notified by email. If true, a consumer will receive notifications for the corresponding notifiable event by email.
-
desiresSms
boolean
false
Indicates whether the consumer wants to be notified by SMS. If true, a consumer will receive notifications for the corresponding notifiable event by SMS.
-
desiresPush
boolean
false
Indicates whether the consumer wants to be notified by push. If true, a consumer will receive notifications for the corresponding notifiable event by push.
The ID of a single consumer’s notification preference.
-
notifiableEvent
object
false
A JSON object that represents a notifiable event.
-
» id
string
false
The ID of the notifiable event.
-
desiresEmail
boolean
false
Indicates whether the consumer wants to be notified by email. If true, a consumer will receive notifications for the corresponding notifiable event by email. The default is false.
-
desiresSms
boolean
false
Indicates whether the consumer wants to be notified by SMS. If true, a consumer will receive notifications for the corresponding notifiable event by SMS. The default is false.
-
desiresPush
boolean
false
Indicates whether the consumer wants to be notified by push notifications from the HealtheLife mobile app. If true, a consumer will receive notifications for the corresponding notifiable event by push. The default is false.
-
createdAt
string(date-time)
false
When a consumer’s notification preference was created, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.
-
updatedAt
string(date-time)
false
When a consumer’s notification preference was last updated, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.
-
postConsumersConsumeridPreferences
Name
Type
Required
Description
Accepted Values
desiresEmail
boolean
false
Indicates whether the consumer wants to be notified by email. If true, a consumer will receive notifications for the corresponding notifiable event by email. The default is false.
-
desiresSms
boolean
false
Indicates whether the consumer wants to be notified by SMS. If true, a consumer will receive notifications for the corresponding notifiable event by SMS. The default is false.
-
desiresPush
boolean
false
Indicates whether the consumer wants to be notified by push notifications from the HealtheLife mobile app. If true, a consumer will receive notifications for the corresponding notifiable event by push. The default is 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.
-
putNotificationContent
Name
Type
Required
Description
Accepted Values
locale
string
false
The locale of the content.
-
notificationType
string
false
The notification type for which the content is created.
-
emailSubject
string
false
The subject of the email notifications that are sent to the consumer.
-
emailContentHtml
string
false
The HTML format of the email body for the notifications sent to the consumer.
-
emailContentPlaintext
string
false
The plain text of the email body for the notifications sent to the consumer.
-
smsContent
string
false
The SMS content for the notifications sent to the consumer.
-
mobilePushSubject
string
false
The mobile push subject for the push notifications sent to the consumer.
-
mobilePushContent
string
false
The mobile push subject for the push notifications sent to the consumer.
-
applicationExperienceDomain
string
false
The domain name of a tenant in the consumer notifications application.
-
postEmailConfigs
Name
Type
Required
Description
Accepted Values
fromName
string
true
Name of the sender that is displayed to the consumer in the email information.
-
fromEmail
string
true
Email of the sender from whom the email is received by the consumer.
-
replyToEmail
string
true
Email address provided by the sender by which the emails are received from the \ consumer when they select the option to reply to the email notification.
-
returnPath
string
true
When an email does not make it to its intended destination, \ the return path indicates where nondelivery receipts—or bounce messages—are to be sent.
Name of the sender that is displayed to the consumer in the email information.
-
fromEmail
string
false
Email of the sender from whom the email is received by the consumer.
-
replyToEmail
string
false
Email address provided by the sender by which the emails are received from the \ consumer when they select the option to reply to the email notification.
-
returnPath
string
false
When an email does not make it to its intended destination, the return path indicates \ where nondelivery receipts—or bounce messages—are to be sent.
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.
-
putEmailConfigs
Name
Type
Required
Description
Accepted Values
fromName
string
false
Name of the sender that is displayed to the consumer in the email information.
-
fromEmail
string
true
Email of the sender from whom the email is received by the consumer.
-
replyToEmail
string
true
Email address provided by the sender by which the emails are received from the \ consumer when they select the option to reply to the email notification.
-
returnPath
string
true
Email address provided by the sender by which the emails are received from the \ consumer when they choose the option to reply to the email notification.
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.
-
Millennium Event Notification Configurations
The Preference Modal Configuration endpoints determine if the user is a first time user or not. If the user is not a first time user, the modal window is not prompted in the patient portal.
Creates new instance of Notification Event Type Configuration
Example Request:
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Content-Type'=>'application/json','Accept'=>'application/json'}result=HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/millennium-event-notification-configurations',headers: headers,body: {"applicationExperienceDomain":"dev.healtheintent.com","eventTypes":[{"type":"RADIOLOGY","throttleMinutes":10}],"isNotificationsEnabled":"true"}.to_json)printJSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/millennium-event-notification-configurations \-H'Authorization: {auth_header}'\-H'Content-Type: application/json'\ \-H'Accept: application/json'\-d{"applicationExperienceDomain":"dev.healtheintent.com","eventTypes":[{"type":"RADIOLOGY","throttleMinutes":10}],"isNotificationsEnabled":"true"}
Lists Notification Event Type Configuration instances
Example Request:
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/millennium-event-notification-configurations',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/millennium-event-notification-configurations \-H'Authorization: {auth_header}'\-H'Accept: application/json'
Lists Notification Event Type Configuration instances.
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.
-
applicationExperienceDomain
query
string
false
N/A
The domain name of a tenant in the consumer notifications application.
Deletes specific instance of Notification Event Type Configuration
Example Request:
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/millennium-event-notification-configurations/{millenniumEventNotificationConfigurationId}',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/millennium-event-notification-configurations/{millenniumEventNotificationConfigurationId}\-H'Authorization: {auth_header}'\-H'Accept: application/json'
Updates specific instance of Notification Event Type Configuration
Example Request:
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Content-Type'=>'application/json','Accept'=>'application/json'}result=HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/millennium-event-notification-configurations/{millenniumEventNotificationConfigurationId}',headers: headers,body: {"applicationExperienceDomain":"dev.healtheintent.com","eventTypes":[{"type":"RADIOLOGY","throttleMinutes":10}],"isNotificationsEnabled":"true"}.to_json)printJSON.pretty_generate(result)
# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/millennium-event-notification-configurations/{millenniumEventNotificationConfigurationId}\-H'Authorization: {auth_header}'\-H'Content-Type: application/json'\ \-H'Accept: application/json'\-d{"applicationExperienceDomain":"dev.healtheintent.com","eventTypes":[{"type":"RADIOLOGY","throttleMinutes":10}],
"isNotificationsEnabled":"true"}
PUT /millennium-event-notification-configurations/{millenniumEventNotificationConfigurationId}
Updates specific instance of Notification Event Type Configuration.
List one specific Notification Event Type Configuration instance
Example Request:
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/millennium-event-notification-configurations/{millenniumEventNotificationConfigurationId}',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-notifications/v1/millennium-event-notification-configurations/{millenniumEventNotificationConfigurationId}\-H'Authorization: {auth_header}'\-H'Accept: application/json'
The human-readable name of the notifiable event. This is used as the display name ifno translation exists in the user’s locale.
-
translations
[object]
true
The translated display name and description of the notifiable event.
-
» locale
string
true
Subtags from the language subtag registry on the Internet Assigned Numbers Authority (IANA) website, formatted according to the RFC 5646 Tags for Identification Languages standard on the IETF website. Note: The links above are to external resources. These resources are provided for reference purposes and should be used with caution. Contact your Cerner support team for more information about third-party content.
-
» displayName
string
true
The translated display name of the notifiable event. When creating a translation for a new locale, this field is required.
-
» description
string
false
The translated text that describes the notifiable event.
Subtags from the language subtag registry on the Internet Assigned Numbers Authority (IANA) website, formatted according to the RFC 5646 Tags for Identification Languages standard on the IETF website. Note: The links above are to external resources. These resources are provided for reference purposes and should be used with caution. Contact your Cerner support team for more information about third-party content.
-
displayName
string
false
The translated display name of the notifiable event. When creating a translation for a new locale, this field is required.
-
description
string
false
The translated text that describes the notifiable event.
-
Error
Name
Type
Required
Description
Accepted Values
code
integer(int32)
true
The HTTP response status code that represents the error.
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.
-
patchNotifiableEvents
Name
Type
Required
Description
Accepted Values
name
string
false
The human-readable name of the notifiable event. This is used as the display name ifno translation exists in the user’s locale.
-
translations
[object]
false
The translated display name and description of the notifiable event.
-
» description
string
false
The translated text that describes the notifiable event.
-
» displayName
string
false
The translated display name of the notifiable event. When creating a translation for a new locale, this field is required.
-
» locale
string
true
Subtags from the language subtag registry on the Internet Assigned Numbers Authority (IANA) website, formatted according to the RFC 5646 Tags for Identification Languages standard on the IETF website. Note: The links above are to external resources. These resources are provided for reference purposes and should be used with caution. Contact your Cerner support team for more information about third-party content.
The subject of the email. This field is required to send email notifications. The maximum length is 889 characters.
-
emailHTML
string
false
The HTML content of the email. Either the {emailHTML} or {emailPlainText} field is required to send email notifications. Both fields can be used in the same request.
-
emailPlainText
string
false
The plain text content of the email. Either the {emailHTML} or {emailPlainText} field is required to send email notifications. Both fields can be used in the same request.
-
pushSubject
string
false
The subject of the mobile push notification. This field is required to send mobile push notifications. The maximum length is 40 characters.
-
pushBody
string
false
The text content of the mobile push notification. This field is required to send mobile push notifications. The maximum length is 1000 characters.
-
smsBody
string
false
The text content of the SMS message. This field is required to send SMS message notifications. The maximum length is 456 characters.
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.
-
patchConsumersConsumeridPreferences
Name
Type
Required
Description
Accepted Values
desiresEmail
boolean
false
Indicates whether the consumer wants to be notified by email. If true, a consumer will receive notifications for the corresponding notifiable event by email.
-
desiresSms
boolean
false
Indicates whether the consumer wants to be notified by SMS. If true, a consumer will receive notifications for the corresponding notifiable event by SMS.
-
desiresPush
boolean
false
Indicates whether the consumer wants to be notified by push. If true, a consumer will receive notifications for the corresponding notifiable event by push.
The ID of a single consumer’s notification preference.
-
notifiableEvent
object
false
A JSON object that represents a notifiable event.
-
» id
string
false
The ID of the notifiable event.
-
desiresEmail
boolean
false
Indicates whether the consumer wants to be notified by email. If true, a consumer will receive notifications for the corresponding notifiable event by email. The default is false.
-
desiresSms
boolean
false
Indicates whether the consumer wants to be notified by SMS. If true, a consumer will receive notifications for the corresponding notifiable event by SMS. The default is false.
-
desiresPush
boolean
false
Indicates whether the consumer wants to be notified by push notifications from the HealtheLife mobile app. If true, a consumer will receive notifications for the corresponding notifiable event by push. The default is false.
-
createdAt
string(date-time)
false
When a consumer’s notification preference was created, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.
-
updatedAt
string(date-time)
false
When a consumer’s notification preference was last updated, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.
-
postConsumersConsumeridPreferences
Name
Type
Required
Description
Accepted Values
desiresEmail
boolean
false
Indicates whether the consumer wants to be notified by email. If true, a consumer will receive notifications for the corresponding notifiable event by email. The default is false.
-
desiresSms
boolean
false
Indicates whether the consumer wants to be notified by SMS. If true, a consumer will receive notifications for the corresponding notifiable event by SMS. The default is false.
-
desiresPush
boolean
false
Indicates whether the consumer wants to be notified by push notifications from the HealtheLife mobile app. If true, a consumer will receive notifications for the corresponding notifiable event by push. The default is 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.
-
putNotificationContent
Name
Type
Required
Description
Accepted Values
locale
string
false
The locale of the content.
-
notificationType
string
false
The notification type for which the content is created.
-
emailSubject
string
false
The subject of the email notifications that are sent to the consumer.
-
emailContentHtml
string
false
The HTML format of the email body for the notifications sent to the consumer.
-
emailContentPlaintext
string
false
The plain text of the email body for the notifications sent to the consumer.
-
smsContent
string
false
The SMS content for the notifications sent to the consumer.
-
mobilePushSubject
string
false
The mobile push subject for the push notifications sent to the consumer.
-
mobilePushContent
string
false
The mobile push subject for the push notifications sent to the consumer.
-
applicationExperienceDomain
string
false
The domain name of a tenant in the consumer notifications application.
-
postEmailConfigs
Name
Type
Required
Description
Accepted Values
fromName
string
true
Name of the sender that is displayed to the consumer in the email information.
-
fromEmail
string
true
Email of the sender from whom the email is received by the consumer.
-
replyToEmail
string
true
Email address provided by the sender by which the emails are received from the \ consumer when they select the option to reply to the email notification.
-
returnPath
string
true
When an email does not make it to its intended destination, \ the return path indicates where nondelivery receipts—or bounce messages—are to be sent.
Name of the sender that is displayed to the consumer in the email information.
-
fromEmail
string
false
Email of the sender from whom the email is received by the consumer.
-
replyToEmail
string
false
Email address provided by the sender by which the emails are received from the \ consumer when they select the option to reply to the email notification.
-
returnPath
string
false
When an email does not make it to its intended destination, the return path indicates \ where nondelivery receipts—or bounce messages—are to be sent.
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.
-
putEmailConfigs
Name
Type
Required
Description
Accepted Values
fromName
string
false
Name of the sender that is displayed to the consumer in the email information.
-
fromEmail
string
true
Email of the sender from whom the email is received by the consumer.
-
replyToEmail
string
true
Email address provided by the sender by which the emails are received from the \ consumer when they select the option to reply to the email notification.
-
returnPath
string
true
Email address provided by the sender by which the emails are received from the \ consumer when they choose the option to reply to the email notification.
Throttle minutes is the time frame in which if multiple notifications are generated for a given notification type, only one notification is sent to the user.
-
isNotificationsEnabled
boolean
false
Indicates whether notifications are enabled or disabled in the portal.
The event type of the notification sent to the user.
-
throttleMinutes
integer(int32)
false
Throttle minutes is the time frame in which if multiple notifications are generated for a given notification type, only one notification is sent to the user.
Throttle minutes is the time frame in which if multiple notifications are generated for a given notification type, only one notification is sent to the user.
-
isNotificationsEnabled
boolean
false
Indicates whether notifications are enabled or disabled in the portal.